crux.api

Class Crux

java.lang.Object

crux.api.Crux

public final class Crux
extends Object

Public API entry point for starting an ICruxAPI.

Method Summary

Modifier and Type	Method and Description
static ICruxAPI	newApiClient(String url) Creates a new remote API client.
static ICruxAPI	newApiClient(String url, RemoteClientOptions options) Creates a new remote API client.
static ICruxAsyncIngestAPI	newIngestClient(Consumer<NodeConfiguration.Builder> f) Starts an ingest-only client for transacting into Crux without running a full local node with index.
static ICruxAsyncIngestAPI	newIngestClient(Map<?,?> options) Starts an ingest-only client for transacting into Crux without running a full local node with index.
static ICruxAsyncIngestAPI	newIngestClient(NodeConfiguration configuration)
static ICruxAPI	startNode() Starts an in-memory query node.
static ICruxAPI	startNode(Consumer<NodeConfiguration.Builder> f) Starts a Crux node using the provided configuration.
static ICruxAPI	startNode(File file) Starts a Crux node using the provided configuration.
static ICruxAPI	startNode(Map<?,?> options) Starts a Crux node using the provided configuration.
static ICruxAPI	startNode(NodeConfiguration configuration)
static ICruxAPI	startNode(URL url) Starts a Crux node using the provided configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startNode

public static ICruxAPI startNode()

Starts an in-memory query node.

When you're done, close the node with Closeable.close()

Returns:

the started node

See Also:

Configuration

startNode

public static ICruxAPI startNode(Map<?,?> options)
                          throws IndexVersionOutOfSyncException

Starts a Crux node using the provided configuration.

When you're done, close the node with Closeable.close()

Parameters:

options - a Map of Crux configuration

Returns:

the started node.

Throws:

IndexVersionOutOfSyncException - if the index needs rebuilding.

See Also:

Configuration

startNode

public static ICruxAPI startNode(File file)
                          throws IndexVersionOutOfSyncException

Starts a Crux node using the provided configuration.

When you're done, close the node with Closeable.close()

Parameters:

file - a JSON or EDN file containing Crux configuration

Returns:

the started node.

Throws:

IndexVersionOutOfSyncException - if the index needs rebuilding.

See Also:

Configuration

startNode

public static ICruxAPI startNode(URL url)
                          throws IndexVersionOutOfSyncException

Starts a Crux node using the provided configuration.

When you're done, close the node with Closeable.close()

Parameters:

url - a URL of a JSON or EDN file containing Crux configuration

Returns:

the started node.

Throws:

IndexVersionOutOfSyncException - if the index needs rebuilding.

See Also:

Configuration

startNode

public static ICruxAPI startNode(Consumer<NodeConfiguration.Builder> f)
                          throws IndexVersionOutOfSyncException

Starts a Crux node using the provided configuration.

 ICruxAPI cruxNode = Crux.startNode(n -> {
   // ...
 });
 

When you're done, close the node with Closeable.close()

Parameters:

f - a callback, provided with an object to configure the node before it starts.

Returns:

the started node.

Throws:

IndexVersionOutOfSyncException - if the index needs rebuilding.

See Also:

Installation, Configuration

startNode

public static ICruxAPI startNode(NodeConfiguration configuration)
                          throws IndexVersionOutOfSyncException

Throws:

IndexVersionOutOfSyncException

newApiClient

public static ICruxAPI newApiClient(String url)

Creates a new remote API client.

NOTE: requires crux-http-client on the classpath.

When you're done, close the node with Closeable.close()

Parameters:

url - the URL to a Crux HTTP end-point.

Returns:

a remote API client.

newApiClient

public static ICruxAPI newApiClient(String url,
                                    RemoteClientOptions options)

Creates a new remote API client.

NOTE: requires crux-http-client on the classpath.

When you're done, close the node with Closeable.close()

Parameters:

url - the URL to a Crux HTTP end-point.

options - options for the remote client.

Returns:

a remote API client.

newIngestClient

public static ICruxAsyncIngestAPI newIngestClient(Map<?,?> options)

Starts an ingest-only client for transacting into Crux without running a full local node with index.

When you're done, close the node with Closeable.close()

Parameters:

options - node configuration options.

Returns:

the started ingest client node.

See Also:

Installation, Configuration

newIngestClient

public static ICruxAsyncIngestAPI newIngestClient(Consumer<NodeConfiguration.Builder> f)

Starts an ingest-only client for transacting into Crux without running a full local node with index.

 ICruxAPI ingestClient = Crux.newIngestClient(n -> {
   // ...
 });
 

When you're done, close the node with Closeable.close()

Parameters:

f - a callback, provided with an object to configure the node before it starts.

Returns:

the started ingest client node.

See Also:

Installation, Configuration

newIngestClient

public static ICruxAsyncIngestAPI newIngestClient(NodeConfiguration configuration)