Interface RowManager

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Interface

  Description

  static enum 

  RowManager.RowSetPart

  Distinguishes between the header and rows that constitute a row set.

  static enum 

  RowManager.RowStructure

  Distinguishes between rows in an object structure or array structure.

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  <T extends JSONReadHandle>
T

  columnInfo(PlanBuilder.Plan plan, T handle)

  This function can be used to inspect the state of a plan before execution.

  <T> T

  columnInfoAs(PlanBuilder.Plan plan, Class<T> as)

  This function can be used to inspect the state of a plan before execution.

  void

  execute(PlanBuilder.Plan plan)

  Execute the given plan without returning any result.

  void

  execute(PlanBuilder.Plan plan, Transaction transaction)

  Execute the given plan without returning any result.

  <T extends StructureReadHandle>
T

  explain(PlanBuilder.Plan plan, T handle)

  Constructs a plan for retrieving a set of database rows and returns a handle for the explanation of the plan as a JSON or XML structure.

  <T> T

  explainAs(PlanBuilder.Plan plan, Class<T> as)

  Constructs a plan for retrieving a set of database rows and returns an explanation of the plan in the representation specified by the IO class.

  <T extends XMLReadHandle>
T

  generateView(PlanBuilder.PreparePlan plan, String schema, String view, T handle)

  Generates generates a view that encapsulates a plan.

  <T> T

  generateViewAs(PlanBuilder.PreparePlan plan, String schema, String view, Class<T> as)

  Generates generates a view that encapsulates a plan.

  RowManager.RowSetPart

  getDatatypeStyle()

  Returns whether data types should be emitted in each row (the default) or in the header in the response for requests made with the row manager.

  Integer

  getOptimize()

   

  RowManager.RowStructure

  getRowStructureStyle()

  Returns whether each row should have an array or object structure in the response for requests made with the row manager.

  String

  getTraceLabel()

   

  <T extends JSONReadHandle>
T

  graphql(JSONWriteHandle query, T resultsHandle)

  Executes a GraphQL query against the database and returns the results as a JSON object.

  <T> T

  graphqlAs(JSONWriteHandle query, Class<T> as)

  Executes a GraphQL query against the database and returns the results as a JSON object.

  PlanBuilder

  newPlanBuilder()

  Creates a builder to define a plan for constructing and retrieving database rows.

  RawPlanDefinition

  newRawPlanDefinition(JSONWriteHandle handle)

  Defines a plan from a JSON serialization of the plan AST (Abstract Syntax Tree).

  RawQueryDSLPlan

  newRawQueryDSLPlan(TextWriteHandle handle)

  Defines a plan from a Query DSL in a JavaScript serialization.

  RawSPARQLSelectPlan

  newRawSPARQLSelectPlan(TextWriteHandle handle)

  Defines a plan from a SPARQL SELECT query.

  RawSQLPlan

  newRawSQLPlan(TextWriteHandle handle)

  Defines a plan from an SQL query.

  <T extends StructureReadHandle>
T

  resultDoc(PlanBuilder.Plan plan, T handle)

  Constructs and retrieves a set of database rows based on a plan using a handle to get the set of rows as a single JSON or XML structure.

  <T extends StructureReadHandle>
T

  resultDoc(PlanBuilder.Plan plan, T handle, Transaction transaction)

  Constructs and retrieves a set of database rows based on a plan using a handle to get the set of rows as a single JSON or XML structure and reflecting documents written or deleted by an uncommitted transaction.

  <T> T

  resultDocAs(PlanBuilder.Plan plan, Class<T> as)

  Constructs and retrieves a set of database rows based on a plan in the representation specified by the IO class.

  <T> T

  resultDocAs(PlanBuilder.Plan plan, Class<T> as, Transaction transaction)

  Constructs and retrieves a set of database rows based on a plan in the representation specified by the IO class and reflecting documents written or deleted by an uncommitted transaction.

  RowSet<RowRecord>

  resultRows(PlanBuilder.Plan plan)

  Constructs and retrieves a set of database rows based on a plan using a map interface for the column values in each row.

  RowSet<RowRecord>

  resultRows(PlanBuilder.Plan plan, Transaction transaction)

  Constructs and retrieves a set of database rows based on a plan using a map interface and reflecting documents written or deleted by an uncommitted transaction.

  <T extends StructureReadHandle>
RowSet<T>

  resultRows(PlanBuilder.Plan plan, T rowHandle)

  Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row.

  <T extends StructureReadHandle>
RowSet<T>

  resultRows(PlanBuilder.Plan plan, T rowHandle, Transaction transaction)

  Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.

  <T> RowSet<T>

  resultRowsAs(PlanBuilder.Plan plan, Class<T> as)

  Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.

  <T> RowSet<T>

  resultRowsAs(PlanBuilder.Plan plan, Class<T> as, Transaction transaction)

  Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.

  void

  setDatatypeStyle(RowManager.RowSetPart style)

  Specifies whether to emit the data type of each column in each row or only in the header in the response for requests made with the row manager.

  void

  setOptimize(Integer value)

  Set an optional optimization level.

  void

  setRowStructureStyle(RowManager.RowStructure style)

  Specifies whether to get each row as an object (the default) or as an array in the response for requests made with the row manager.

  void

  setTraceLabel(String label)

  Set an optional label and enable the "optic" trace event for the duration of each plan execution

  RowManager

  withUpdate(boolean update)

  As of MarkLogic 11.2, the "v1/rows/update" endpoint must be used in order to submit an Optic plan that performs an update.

• Method Details

  • newPlanBuilder

    PlanBuilder newPlanBuilder()
    Creates a builder to define a plan for constructing and retrieving database rows.

    Returns:

    a builder for row plans

  • getDatatypeStyle

    RowManager.RowSetPart getDatatypeStyle()
    Returns whether data types should be emitted in each row (the default) or in the header in the response for requests made with the row manager.

    Returns:

    the part of the row set that identifies the column data types

  • setDatatypeStyle

    void setDatatypeStyle(RowManager.RowSetPart style)
    Specifies whether to emit the data type of each column in each row or only in the header in the response for requests made with the row manager. The distinction is significant when getting the rows as JSON or XML. Because the server supports columns with variant data types, the default is in each row. You can configure the row manager to return more concise objects if the data type is consistent or if you aren't using the data type.

    Parameters:

    style - the part of the rowset that should contain data types

  • getRowStructureStyle

    RowManager.RowStructure getRowStructureStyle()
    Returns whether each row should have an array or object structure in the response for requests made with the row manager.

    Returns:

    the style of row structure

  • setRowStructureStyle

    void setRowStructureStyle(RowManager.RowStructure style)
    Specifies whether to get each row as an object (the default) or as an array in the response for requests made with the row manager. The distinction is significant when getting the rows as JSON and also when executing a map or reduce function on the server.

    Parameters:

    style - the structure of rows in the response

  • setTraceLabel

    void setTraceLabel(String label)
    Set an optional label and enable the "optic" trace event for the duration of each plan execution

    Parameters:

    label -

  • withUpdate

    RowManager withUpdate(boolean update)
    As of MarkLogic 11.2, the "v1/rows/update" endpoint must be used in order to submit an Optic plan that performs an update. This method must be called with a value of true in order for that endpoint to be used instead of "v1/rows". You may later call this method with a value of false in order to submit a plan that does not perform an update.

    Parameters:

    update - set to true if submitting a plan that performs an update

    Returns:

    the instance of this class

    Since:

    6.5.0

  • getTraceLabel

    String getTraceLabel()

    Returns:

    the label that will be used for all log messages associated with the "optic" trace event

  • setOptimize

    void setOptimize(Integer value)
    Set an optional optimization level. Must be zero or higher.

    Parameters:

    value -

  • getOptimize

    Integer getOptimize()

    Returns:

    optional optimization level

  • newRawPlanDefinition

    RawPlanDefinition newRawPlanDefinition(JSONWriteHandle handle)
    Defines a plan from a JSON serialization of the plan AST (Abstract Syntax Tree).

    Parameters:

    handle - a handle for a JSON serialization of a plan AST

    Returns:

    a plan for constructing and retrieving database rows

  • newRawQueryDSLPlan

    RawQueryDSLPlan newRawQueryDSLPlan(TextWriteHandle handle)
    Defines a plan from a Query DSL in a JavaScript serialization.

    Parameters:

    handle - a textual handle for Query DSL in JavaScript format

    Returns:

    a plan for constructing and retrieving database rows

  • newRawSQLPlan

    RawSQLPlan newRawSQLPlan(TextWriteHandle handle)
    Defines a plan from an SQL query.

    Parameters:

    handle - a textual handle for the SQL serialization

    Returns:

    a plan for constructing and retrieving database rows

  • newRawSPARQLSelectPlan

    RawSPARQLSelectPlan newRawSPARQLSelectPlan(TextWriteHandle handle)
    Defines a plan from a SPARQL SELECT query.

    Parameters:

    handle - a textual handle for the SPARQL serialization

    Returns:

    a plan for constructing and retrieving database rows

  • execute

    void execute(PlanBuilder.Plan plan)
    Execute the given plan without returning any result.

    Parameters:

    plan - the definition of a plan

  • execute

    void execute(PlanBuilder.Plan plan, Transaction transaction)
    Execute the given plan without returning any result.

    Parameters:

    plan - the definition of a plan

    transaction - a open transaction for the execute operation to run within

  • resultRows

    RowSet<RowRecord> resultRows(PlanBuilder.Plan plan)
    Constructs and retrieves a set of database rows based on a plan using a map interface for the column values in each row.

    Parameters:

    plan - the definition of a plan for the database rows

    Returns:

    an iterable over the results with a map interface

  • resultRows

    RowSet<RowRecord> resultRows(PlanBuilder.Plan plan, Transaction transaction)
    Constructs and retrieves a set of database rows based on a plan using a map interface and reflecting documents written or deleted by an uncommitted transaction.

    Parameters:

    plan - the definition of a plan for the database rows

    transaction - a open transaction for documents from which rows have been projected

    Returns:

    an iterable over the results with a map interface for each row

  • resultRows

    <T extends StructureReadHandle> RowSet<T> resultRows(PlanBuilder.Plan plan, T rowHandle)
    Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row.

    Type Parameters:

    T - the type of the row handle

    Parameters:

    plan - the definition of a plan for the database rows

    rowHandle - the JSON or XML handle that provides each row

    Returns:

    an iterable over the result rows

  • resultRows

    <T extends StructureReadHandle> RowSet<T> resultRows(PlanBuilder.Plan plan, T rowHandle, Transaction transaction)
    Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.

    Type Parameters:

    T - the type of the row handle

    Parameters:

    plan - the definition of a plan for the database rows

    rowHandle - the JSON or XML handle that provides each row

    transaction - a open transaction for documents from which rows have been projected

    Returns:

    an iterable over the result rows

  • resultRowsAs

    <T> RowSet<T> resultRowsAs(PlanBuilder.Plan plan, Class<T> as)
    Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of object that will be returned by the handle registered for it

    Parameters:

    plan - the definition of a plan for the database rows

    as - the IO class for reading each row as JSON or XML content

    Returns:

    an iterable over the result rows

  • resultRowsAs

    <T> RowSet<T> resultRowsAs(PlanBuilder.Plan plan, Class<T> as, Transaction transaction)
    Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of object that will be returned by the handle registered for it

    Parameters:

    plan - the definition of a plan for the database rows

    as - the IO class for reading each row as JSON or XML content

    transaction - a open transaction for documents from which rows have been projected

    Returns:

    an iterable over the result rows

  • resultDoc

    <T extends StructureReadHandle> T resultDoc(PlanBuilder.Plan plan, T handle)
    Constructs and retrieves a set of database rows based on a plan using a handle to get the set of rows as a single JSON or XML structure.

    Type Parameters:

    T - the type of the row handle

    Parameters:

    plan - the definition of a plan for the database rows

    handle - the JSON or XML handle for the set of rows

    Returns:

    the JSON or XML handle populated with the set of rows

  • resultDoc

    <T extends StructureReadHandle> T resultDoc(PlanBuilder.Plan plan, T handle, Transaction transaction)
    Constructs and retrieves a set of database rows based on a plan using a handle to get the set of rows as a single JSON or XML structure and reflecting documents written or deleted by an uncommitted transaction.

    Type Parameters:

    T - the type of the row handle

    Parameters:

    plan - the definition of a plan for the database rows

    handle - the JSON or XML handle for the set of rows

    transaction - a open transaction for documents from which rows have been projected

    Returns:

    the JSON or XML handle populated with the set of rows

  • resultDocAs

    <T> T resultDocAs(PlanBuilder.Plan plan, Class<T> as)
    Constructs and retrieves a set of database rows based on a plan in the representation specified by the IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of the IO object for reading the set of rows

    Parameters:

    plan - the definition of a plan for the database rows

    as - the IO class for reading the set of rows

    Returns:

    an object of the IO class with the content of the set of rows

  • resultDocAs

    <T> T resultDocAs(PlanBuilder.Plan plan, Class<T> as, Transaction transaction)
    Constructs and retrieves a set of database rows based on a plan in the representation specified by the IO class and reflecting documents written or deleted by an uncommitted transaction. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of the IO object for reading the set of rows

    Parameters:

    plan - the definition of a plan for the database rows

    as - the IO class for reading the set of rows

    transaction - a open transaction for documents from which rows have been projected

    Returns:

    an object of the IO class with the content of the set of rows

  • explain

    <T extends StructureReadHandle> T explain(PlanBuilder.Plan plan, T handle)
    Constructs a plan for retrieving a set of database rows and returns a handle for the explanation of the plan as a JSON or XML structure.

    Type Parameters:

    T - the type of the explanation handle

    Parameters:

    plan - the definition of a plan for database rows

    handle - the JSON or XML handle on the explanation for the plan

    Returns:

    the handle with the content of the explanation for the plan

  • explainAs

    <T> T explainAs(PlanBuilder.Plan plan, Class<T> as)
    Constructs a plan for retrieving a set of database rows and returns an explanation of the plan in the representation specified by the IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of the IO object for reading the explanation

    Parameters:

    plan - the definition of a plan for database rows

    as - the IO class for reading the explanation for the plan

    Returns:

    an object of the IO class with the content of the explanation for the plan

  • generateView

    <T extends XMLReadHandle> T generateView(PlanBuilder.PreparePlan plan, String schema, String view, T handle)
    Generates generates a view that encapsulates a plan. Insert the generated XML into the schemas database and then use the PlanBuilder.fromView(String, String) accessor to query against the generated view.

    Type Parameters:

    T - the type of the handle for the generated view

    Parameters:

    plan - the definition of a plan for database rows

    schema - the name of the schema for the new view generated from the plan

    view - the name of the new view generated from the plan

    handle - the XML handle on the generated view for the plan

    Returns:

    the handle with the content of the generated view for the plan

  • generateViewAs

    <T> T generateViewAs(PlanBuilder.PreparePlan plan, String schema, String view, Class<T> as)
    Generates generates a view that encapsulates a plan. Insert the generated XML into the schemas database and then use the PlanBuilder.fromView(String, String) accessor to query against the generated view. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of the IO object for reading the generated view

    Parameters:

    plan - the definition of a plan for database rows

    schema - the name of the schema for the new view generated from the plan

    view - the name of the new view generated from the plan

    as - the IO class for reading the generated view for the plan

    Returns:

    an object of the IO class with the content of the generated view for the plan

  • columnInfo

    <T extends JSONReadHandle> T columnInfo(PlanBuilder.Plan plan, T handle)
    This function can be used to inspect the state of a plan before execution. It returns the information about each column in the plan, including schema name, view name, column name, data type and nullability. It also returns the information about system columns.

    Type Parameters:

    T - the type of the handle for the column information

    Parameters:

    plan - the definition of a plan for database rows

    handle - the Json handle on the column information for the plan

    Returns:

    the handle with the content of the column information for the plan

  • columnInfoAs

    <T> T columnInfoAs(PlanBuilder.Plan plan, Class<T> as)
    This function can be used to inspect the state of a plan before execution. It returns the information about each column in the plan, including schema name, view name, column name, data type and nullability. It also returns the information about system columns. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of the IO object for reading the column information

    Parameters:

    plan - the definition of a plan for database rows

    as - the IO class for reading the column information for the plan

    Returns:

    an object of the IO class with the content of the column information for the plan

  • graphql

    <T extends JSONReadHandle> T graphql(JSONWriteHandle query, T resultsHandle)
    Executes a GraphQL query against the database and returns the results as a JSON object.

    Type Parameters:

    T - the type of the IO object for r the results

    Parameters:

    query - the GraphQL query to execute

    resultsHandle - the IO class for capturing the results

    Returns:

    an object of the IO class containing the query results, which will include error messages if the query fails

    Since:

    6.2.0

  • graphqlAs

    <T> T graphqlAs(JSONWriteHandle query, Class<T> as)
    Executes a GraphQL query against the database and returns the results as a JSON object.

    Type Parameters:

    T - the type of the results to return

    Parameters:

    query - the GraphQL query to execute

    as - the class type of the results to return; typically JsonNode or String

    Returns:

    an instance of the given return type that contains the query results, which will include error messages if the query fails

    Since:

    6.2.0

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.