Namespace: ColumnBuilder
planBuilder. ColumnBuilder
ColumnBuilder object to construct a view
for op.fromDocs. This class has been modified from the
auto-generated classes to add chaining behavior to the methods to
collect multiple method calls into a single ColumnBuilder object to
send to /v1/rows. This is done by returning a new
PlanColumnBuilderBase and follows the PatchBuilder pattern.
- Since:
-
- 4.1.0
Methods
-
-
addColumn(column) → {planBuilder.ColumnBuilder}
-
Create a new column definition for use with op:from-docs. This method initializes the column with default properties unless overridden by additional chained methods. Default behavior (when no other properties are set, such as xpath(), type(), or nullable()): - XPath: ./name (where name is the name passed to add-column()). - Type: string - Nullable: true Provides a client interface to a server function. See op.addColumn This method initializes the column with default properties unless overridden by additional chained methods. Default behavior (when no other properties are set, such as xpath(), type(), or nullable()): - XPath: ./name (where name is the name passed to add-column()). - Type: string - Nullable: true Provides a client interface to a server function. See op.addColumn
Parameters:
Name Type Argument Description columnPlanColumnName <optional>
The name of the column to add, specified either as a string or as a PlanColumn. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation. - Since:
-
- 4.1.0
Returns:
-
-
collation(collation) → {planBuilder.ColumnBuilder}
-
Sets the collation for the column created by op:add-column. This only applies to columns with string types, as collations specify the order in which strings are sorted and how they are compared. Provides a client interface to a server function. See op.collation
Parameters:
Name Type Argument Description collationXsString <optional>
the collation for string types - Since:
-
- 4.1.0
Returns:
-
-
coordinateSystem(coordinateSystem) → {planBuilder.ColumnBuilder}
-
Sets the coordinate-system for the column created by op:add-column. This only applies to columns with geo types. Provides a client interface to a server function. See op.coordinateSystem
Parameters:
Name Type Argument Description coordinateSystemXsString <optional>
the coordinate system for geo types - Since:
-
- 4.1.0
Returns:
-
-
default(defaultExpression) → {planBuilder.ColumnBuilder}
-
Sets the default value for the column created by op:add-column. Provides a client interface to a server function. See op.default
Parameters:
Name Type Argument Description defaultExpressionItem <optional>
the default value for the column - Since:
-
- 4.1.0
Returns:
-
-
dimension(dimension) → {planBuilder.ColumnBuilder}
-
Sets the vector dimension for the column created by op:add-column. It only applies when the column's type is set to "vector". If the vector to be extracted does not have the same dimension, the value will be rejected. There's no default dimension. Vectors of all dimensions are extracted. Provides a client interface to a server function. See op.dimension
Parameters:
Name Type Argument Description dimensionXsUnsignedInt <optional>
the vector dimension for the column - Since:
-
- 4.1.0
Returns:
-
-
expr(expression) → {planBuilder.ColumnBuilder}
-
Sets the expression to create content or extract content from a document for the column created by op:add-column. It cannot be used together with op:xpath, as both of them define the content of the column. Provides a client interface to a server function. See op.expr
Parameters:
Name Type Argument Description expressionItem <optional>
the expression to create content or extract content from a document for the column - Since:
-
- 4.1.0
Returns:
-
-
nullable(bool) → {planBuilder.ColumnBuilder}
-
Set the column created by op:add-column nullable or not. Provides a client interface to a server function. See op.nullable
Parameters:
Name Type Argument Description boolXsBoolean <optional>
whether the column is nullable - Since:
-
- 4.1.0
Returns:
-
-
type(type) → {planBuilder.ColumnBuilder}
-
Set the data type of the column created by op:add-column. Provides a client interface to a server function. See op.type
Parameters:
Name Type Argument Description typeXsString <optional>
the data type of the column - Since:
-
- 4.1.0
Returns:
-
-
units(units) → {planBuilder.ColumnBuilder}
-
Sets the units for the column created by op:add-column. This only applies to columns with geo types. Provides a client interface to a server function. See op.units
Parameters:
Name Type Argument Description unitsXsString <optional>
the units for the column - Since:
-
- 4.1.0
Returns:
-
-
xpath(path) → {planBuilder.ColumnBuilder}
-
This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join. The path is an XPath (specified as a string) to apply to each node to generate a sequence of nodes as an expression value. Sets the XPath expression in the document from which to extract content for the column created by op:add-column. It cannot be used together with op:expr, as both of them define the content of the column. Provides a client interface to a server function. See op.xpath
Parameters:
Name Type Argument Description pathXsString <optional>
The XPath expression, specified as a string, to apply to each node in the source column in order to extract child nodes or content for the column created by op:add-column. - Since:
-
- 4.1.0
Returns: