Package io.stargate.bridge.proto

Interface StargateBridge

All Superinterfaces:
io.quarkus.grpc.MutinyService
All Known Implementing Classes:
RetriableStargateBridge, StargateBridgeClient
@Generated(value="by Mutiny Grpc generator", comments="Source: bridge.proto") public interface StargateBridge extends io.quarkus.grpc.MutinyService

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<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.
    io.smallrye.mutiny.Uni<io.stargate.bridge.proto.Schema.CqlKeyspaceDescribe>
    describeKeyspace(io.stargate.bridge.proto.Schema.DescribeKeyspaceQuery request)
    Similar to CQL "DESCRIBE KEYSPACE".
    io.smallrye.mutiny.Uni<io.stargate.bridge.proto.QueryOuterClass.Response>
    executeBatch(io.stargate.bridge.proto.QueryOuterClass.Batch request)
    Executes a batch of CQL queries.
    io.smallrye.mutiny.Uni<io.stargate.bridge.proto.QueryOuterClass.Response>
    executeQuery(io.stargate.bridge.proto.QueryOuterClass.Query request)
    Executes a single CQL query.
    io.smallrye.mutiny.Uni<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.
    io.smallrye.mutiny.Uni<io.stargate.bridge.proto.Schema.SupportedFeaturesResponse>
    getSupportedFeatures(io.stargate.bridge.proto.Schema.SupportedFeaturesRequest request)
    Checks which features are supported by the persistence backend.

  • Method Details

    • executeQuery

      io.smallrye.mutiny.Uni<io.stargate.bridge.proto.QueryOuterClass.Response> executeQuery(io.stargate.bridge.proto.QueryOuterClass.Query request)
        Executes a single CQL query.

    • executeQueryWithSchema

      io.smallrye.mutiny.Uni<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

      io.smallrye.mutiny.Uni<io.stargate.bridge.proto.QueryOuterClass.Response> executeBatch(io.stargate.bridge.proto.QueryOuterClass.Batch request)
        Executes a batch of CQL queries.

    • describeKeyspace

      io.smallrye.mutiny.Uni<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

      io.smallrye.mutiny.Uni<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

      io.smallrye.mutiny.Uni<io.stargate.bridge.proto.Schema.SupportedFeaturesResponse> getSupportedFeatures(io.stargate.bridge.proto.Schema.SupportedFeaturesRequest request)
        Checks which features are supported by the persistence backend.