Package io.stargate.bridge.proto

Interface StargateBridgeGrpc.AsyncService

All Known Implementing Classes:
StargateBridgeGrpc.StargateBridgeImplBase
Enclosing class:
StargateBridgeGrpc
public static interface StargateBridgeGrpc.AsyncService
 The gPRC API used by Stargate services to interact with the persistence backend.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    authorizeSchemaReads(io.stargate.bridge.proto.Schema.AuthorizeSchemaReadsRequest request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.AuthorizeSchemaReadsResponse> responseObserver)
    Checks whether the client is authorized to describe one or more schema elements.
    default void
    describeKeyspace(io.stargate.bridge.proto.Schema.DescribeKeyspaceQuery request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.CqlKeyspaceDescribe> responseObserver)
    Similar to CQL "DESCRIBE KEYSPACE".
    default void
    executeBatch(io.stargate.bridge.proto.QueryOuterClass.Batch request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.QueryOuterClass.Response> responseObserver)
    Executes a batch of CQL queries.
    default void
    executeQuery(io.stargate.bridge.proto.QueryOuterClass.Query request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.QueryOuterClass.Response> responseObserver)
    Executes a single CQL query.
    default void
    executeQueryWithSchema(io.stargate.bridge.proto.Schema.QueryWithSchema request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.QueryWithSchemaResponse> responseObserver)
    Executes a single CQL query, assuming that a keyspace with the given version hash exists on the bridge side.
    default void
    getSupportedFeatures(io.stargate.bridge.proto.Schema.SupportedFeaturesRequest request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.SupportedFeaturesResponse> responseObserver)
    Checks which features are supported by the persistence backend.

  • Method Details

    • executeQuery

      default void executeQuery(io.stargate.bridge.proto.QueryOuterClass.Query request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.QueryOuterClass.Response> responseObserver)
       Executes a single CQL query.

    • executeQueryWithSchema

      default void executeQueryWithSchema(io.stargate.bridge.proto.Schema.QueryWithSchema request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.QueryWithSchemaResponse> responseObserver)
       Executes a single CQL query, assuming that a keyspace with the given version hash exists on the
 bridge side.
 This is an optimization when the client builds a query based on a keyspace's contents: with
 this operation, it can use its local version of the keyspace (therefore avoiding an extra
 network hop to fetch it), and execute the query optimistically. If the keyspace has changed,
 the bridge will reply with the new version, allowing the client to retry.

    • executeBatch

      default void executeBatch(io.stargate.bridge.proto.QueryOuterClass.Batch request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.QueryOuterClass.Response> responseObserver)
       Executes a batch of CQL queries.

    • describeKeyspace

      default void describeKeyspace(io.stargate.bridge.proto.Schema.DescribeKeyspaceQuery request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.CqlKeyspaceDescribe> responseObserver)
       Similar to CQL "DESCRIBE KEYSPACE".
 Note that this operation does not perform any authorization check. The rationale is that, most
 of the time, client services use schema metadata to build another query that will be
 immediately executed with `ExecuteQuery` (which does check authorization).
 If that is not the case (e.g. you return the metadata directly to the client), you can check
 authorization explicitly with `AuthorizeSchemaReads`.

    • authorizeSchemaReads

      default void authorizeSchemaReads(io.stargate.bridge.proto.Schema.AuthorizeSchemaReadsRequest request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.AuthorizeSchemaReadsResponse> responseObserver)
       Checks whether the client is authorized to describe one or more schema elements.

    • getSupportedFeatures

      default void getSupportedFeatures(io.stargate.bridge.proto.Schema.SupportedFeaturesRequest request, io.grpc.stub.StreamObserver<io.stargate.bridge.proto.Schema.SupportedFeaturesResponse> responseObserver)
       Checks which features are supported by the persistence backend.