Package com.marklogic.client.row

Interface RowManager

public interface RowManager

A Row Manager provides database operations on rows projected from documents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RowManager.RowSetPart	Distinguishes between the header and rows that constitute a row set.
static class	RowManager.RowStructure	Distinguishes between rows in an object structure or array structure.

Method Summary

Modifier and Type	Method	Description
<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, java.lang.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.
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.
RowManager.RowStructure	getRowStructureStyle()	Returns whether each row should have an array or object structure in the response for requests made with the row manager.
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).
<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, java.lang.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, java.lang.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, java.lang.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, java.lang.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	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.

Method Detail

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

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 PlanAST

Returns:

a plan for constructing and retrieving database rows

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,
                           java.lang.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,
                           java.lang.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,
                  java.lang.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,
                  java.lang.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:

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

explainAs

<T> T explainAs(PlanBuilder.Plan plan,
                java.lang.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