com.marklogic.hub.dataservices

Interface StepRunnerService

public interface StepRunnerService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
com.marklogic.client.SessionState	newSessionState() Creates an object to track a session for a set of operations that require session state on the database server.
static StepRunnerService	on(com.marklogic.client.DatabaseClient db) Creates a StepRunnerService object for executing operations on the database server.
static StepRunnerService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a StepRunnerService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	processBatch(com.marklogic.client.SessionState api_session, com.fasterxml.jackson.databind.JsonNode inputs) Replacement for the mlRunFlow REST extension; processes a batch of items using the given flow and step

Method Detail

on

static StepRunnerService on(com.marklogic.client.DatabaseClient db)

Creates a StepRunnerService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads.

Parameters:

db - provides a client for communicating with the database server

Returns:

an object for executing database operations

on

static StepRunnerService on(com.marklogic.client.DatabaseClient db,
                            com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a StepRunnerService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads. The service declaration uses a custom implementation of the same service instead of the default implementation of the service by specifying an endpoint directory in the modules database with the implementation. A service.json file with the declaration can be read with FileHandle or a string serialization of the JSON declaration with StringHandle.

Parameters:

db - provides a client for communicating with the database server

serviceDeclaration - substitutes a custom implementation of the service

Returns:

an object for executing database operations

newSessionState

com.marklogic.client.SessionState newSessionState()

Creates an object to track a session for a set of operations that require session state on the database server.

Returns:

an object for session state

processBatch

com.fasterxml.jackson.databind.JsonNode processBatch(com.marklogic.client.SessionState api_session,
                                                     com.fasterxml.jackson.databind.JsonNode inputs)

Replacement for the mlRunFlow REST extension; processes a batch of items using the given flow and step

Parameters:

api_session - Holds the session object

inputs - provides input

Returns:

as output