io.stargate.sgv2.common.grpc

Interface StargateBridgeClient

public interface StargateBridgeClient

The client that allows Stargate services to communicate with the "bridge" to the persistence backend.

Method Summary

Modifier and Type	Method and Description
default boolean	authorizeSchemaRead(Schema.SchemaRead schemaRead) Convenience method to call authorizeSchemaReads(List) with a single element.
default CompletionStage<Boolean>	authorizeSchemaReadAsync(Schema.SchemaRead schemaRead) Convenience method to call authorizeSchemaReadsAsync(List) with a single element.
default List<Boolean>	authorizeSchemaReads(List<Schema.SchemaRead> schemaReads)
CompletionStage<List<Boolean>>	authorizeSchemaReadsAsync(List<Schema.SchemaRead> schemaReads) Checks whether this client is authorized to describe a set of schema elements.
String	decorateKeyspaceName(String keyspaceName) Converts a keyspace name used by this client to the "global" one actually used by the persistence backend.
default QueryOuterClass.Response	executeBatch(QueryOuterClass.Batch batch)
CompletionStage<QueryOuterClass.Response>	executeBatchAsync(QueryOuterClass.Batch batch) Executes a CQL batch.
default QueryOuterClass.Response	executeQuery(QueryOuterClass.Query query)
CompletionStage<QueryOuterClass.Response>	executeQueryAsync(QueryOuterClass.Query query) Executes a CQL query.
default List<Schema.CqlKeyspaceDescribe>	getAllKeyspaces()
CompletionStage<List<Schema.CqlKeyspaceDescribe>>	getAllKeyspacesAsync() Gets the metadata describing all the keyspaces that are visible to this client.
default Optional<Schema.CqlKeyspaceDescribe>	getKeyspace(String keyspaceName, boolean checkIfAuthorized)
CompletionStage<Optional<Schema.CqlKeyspaceDescribe>>	getKeyspaceAsync(String keyspaceName, boolean checkIfAuthorized) Gets the metadata describing the given keyspace.
default Optional<Schema.CqlTable>	getTable(String keyspaceName, String tableName, boolean checkIfAuthorized)
CompletionStage<Optional<Schema.CqlTable>>	getTableAsync(String keyspaceName, String tableName, boolean checkIfAuthorized) Gets the metadata describing the given table.
default List<Schema.CqlTable>	getTables(String keyspaceName)
CompletionStage<List<Schema.CqlTable>>	getTablesAsync(String keyspaceName) Gets the metadata describing all the tables that are visible to this client in the given keyspace.

Method Detail

executeQueryAsync

CompletionStage<QueryOuterClass.Response> executeQueryAsync(QueryOuterClass.Query query)

Executes a CQL query.

Authorization is automatically handled by the persistence backend.

executeQuery

default QueryOuterClass.Response executeQuery(QueryOuterClass.Query query)

See Also:

#executeQueryAsync(Query)

executeBatchAsync

CompletionStage<QueryOuterClass.Response> executeBatchAsync(QueryOuterClass.Batch batch)

Executes a CQL batch.

Authorization is automatically handled by the persistence backend.

executeBatch

default QueryOuterClass.Response executeBatch(QueryOuterClass.Batch batch)

See Also:

#executeBatchAsync(Batch)

getKeyspaceAsync

CompletionStage<Optional<Schema.CqlKeyspaceDescribe>> getKeyspaceAsync(String keyspaceName,
                                                                       boolean checkIfAuthorized)

Gets the metadata describing the given keyspace.

Parameters:

checkIfAuthorized - whether to check if the current user is allowed to describe this keyspace (this requires an additional background call to the bridge). This is an optimization: if you only use the schema metadata to build a DML query that will be executed immediately after, you can skip authorization since #executeQueryAsync(Query) does it automatically. However, if there is no other query and you build a client response directly from the metadata, then authorization should be done by this method.

Throws:

UnauthorizedKeyspaceException - (wrapped in the returned future) if checkIfAuthorized is set, and the client is not allowed to access this keyspace. However, this check is shallow: if the caller surfaces keyspace elements (tables, UDTs...) to the end user, it must authorize them individually with authorizeSchemaReads(List).

getKeyspace

default Optional<Schema.CqlKeyspaceDescribe> getKeyspace(String keyspaceName,
                                                         boolean checkIfAuthorized)
                                                  throws UnauthorizedKeyspaceException

Throws:

UnauthorizedKeyspaceException

See Also:

getKeyspaceAsync(String, boolean)

getAllKeyspacesAsync

CompletionStage<List<Schema.CqlKeyspaceDescribe>> getAllKeyspacesAsync()

Gets the metadata describing all the keyspaces that are visible to this client.

This method automatically filters out unauthorized keyspaces. However, this check is shallow: if the caller surfaces keyspace elements (tables, UDTs...) to the end user, it must authorize them individually with authorizeSchemaReads(List).

getAllKeyspaces

default List<Schema.CqlKeyspaceDescribe> getAllKeyspaces()

See Also:

getAllKeyspacesAsync()

decorateKeyspaceName

String decorateKeyspaceName(String keyspaceName)

Converts a keyspace name used by this client to the "global" one actually used by the persistence backend. In other words, this provides a way to compute Schema.CqlKeyspace#getGlobalName() from Schema.CqlKeyspace#getName().

getTableAsync

CompletionStage<Optional<Schema.CqlTable>> getTableAsync(String keyspaceName,
                                                         String tableName,
                                                         boolean checkIfAuthorized)

Gets the metadata describing the given table.

Parameters:

checkIfAuthorized - see explanations in getKeyspaceAsync(String, boolean).

Throws:

UnauthorizedTableException - (wrapped in the returned future) if checkIfAuthorized is set, and the client is not allowed to access this table.

getTable

default Optional<Schema.CqlTable> getTable(String keyspaceName,
                                           String tableName,
                                           boolean checkIfAuthorized)
                                    throws UnauthorizedTableException

Throws:

UnauthorizedTableException

See Also:

getTableAsync(String, String, boolean)

getTablesAsync

CompletionStage<List<Schema.CqlTable>> getTablesAsync(String keyspaceName)

Gets the metadata describing all the tables that are visible to this client in the given keyspace.

This method automatically filters out unauthorized tables.

getTables

default List<Schema.CqlTable> getTables(String keyspaceName)

See Also:

getTableAsync(String, String, boolean)

authorizeSchemaReadsAsync

CompletionStage<List<Boolean>> authorizeSchemaReadsAsync(List<Schema.SchemaRead> schemaReads)

Checks whether this client is authorized to describe a set of schema elements.

See Also:

SchemaReads

authorizeSchemaReads

default List<Boolean> authorizeSchemaReads(List<Schema.SchemaRead> schemaReads)

See Also:

authorizeSchemaReadsAsync(List), SchemaReads

authorizeSchemaReadAsync

default CompletionStage<Boolean> authorizeSchemaReadAsync(Schema.SchemaRead schemaRead)

Convenience method to call authorizeSchemaReadsAsync(List) with a single element.

See Also:

SchemaReads

authorizeSchemaRead

default boolean authorizeSchemaRead(Schema.SchemaRead schemaRead)

Convenience method to call authorizeSchemaReads(List) with a single element.

See Also:

SchemaReads