Package io.stargate.bridge.proto

Class StargateBridgeGrpc.StargateBridgeFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<StargateBridgeGrpc.StargateBridgeFutureStub>
io.stargate.bridge.proto.StargateBridgeGrpc.StargateBridgeFutureStub
Enclosing class:
StargateBridgeGrpc
public static class StargateBridgeGrpc.StargateBridgeFutureStub extends io.grpc.stub.AbstractFutureStub<StargateBridgeGrpc.StargateBridgeFutureStub>
 The gPRC API used by Stargate services to interact with the persistence backend.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

  • Method Summary

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

    Methods inherited from class io.grpc.stub.AbstractFutureStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

    Methods inherited from class java.lang.Object

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

  • Method Details

    • build

      protected StargateBridgeGrpc.StargateBridgeFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<StargateBridgeGrpc.StargateBridgeFutureStub>

    • executeQuery

      public com.google.common.util.concurrent.ListenableFuture<io.stargate.bridge.proto.QueryOuterClass.Response> executeQuery(io.stargate.bridge.proto.QueryOuterClass.Query request)
       Executes a single CQL query.

    • executeQueryWithSchema

      public com.google.common.util.concurrent.ListenableFuture<io.stargate.bridge.proto.Schema.QueryWithSchemaResponse> executeQueryWithSchema(io.stargate.bridge.proto.Schema.QueryWithSchema request)
       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

      public com.google.common.util.concurrent.ListenableFuture<io.stargate.bridge.proto.QueryOuterClass.Response> executeBatch(io.stargate.bridge.proto.QueryOuterClass.Batch request)
       Executes a batch of CQL queries.

    • describeKeyspace

      public com.google.common.util.concurrent.ListenableFuture<io.stargate.bridge.proto.Schema.CqlKeyspaceDescribe> describeKeyspace(io.stargate.bridge.proto.Schema.DescribeKeyspaceQuery request)
       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

      public com.google.common.util.concurrent.ListenableFuture<io.stargate.bridge.proto.Schema.AuthorizeSchemaReadsResponse> authorizeSchemaReads(io.stargate.bridge.proto.Schema.AuthorizeSchemaReadsRequest request)
       Checks whether the client is authorized to describe one or more schema elements.

    • getSupportedFeatures

      public com.google.common.util.concurrent.ListenableFuture<io.stargate.bridge.proto.Schema.SupportedFeaturesResponse> getSupportedFeatures(io.stargate.bridge.proto.Schema.SupportedFeaturesRequest request)
       Checks which features are supported by the persistence backend.