Categorygithub.com/pluralsh/database-interface-apispec
package
0.0.6
Repository: https://github.com/pluralsh/database-interface-api.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
9
Dependents
6
Files
1.7k SLOC

# README

Database Interface Spec

This repository hosts the gRPC API for the Database standard. The interfaces defined in the gRPC specification are meant to be the common interface for database object provisioning and management across various database object vendors.

Build and Test

  1. database.proto is generated from the specification defined in spec.md

  2. In order to update the API, make changes to spec.md. Then, generate database.proto using:

# generates cosi.proto
make generate-spec
  1. Do it all in 1 step:
# generates database.proto and builds the go bindings
make all

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

Default, disallow uncredentialed access to the backend storage.
Read only, uncredentialed users can call ListDatabase and GetObject.
Read/Write, uncredentialed users can read objects as well as PutObject.
No description provided by the author
Write only, uncredentialed users can only call PutObject.
Storageaccount based authentication.
Default, KEY based authentication.
No description provided by the author
S3V2, Signature version v2.
S3V4, Signature version v4.
No description provided by the author

# Variables

Enum value maps for AnonymousDatabaseAccessMode.
Enum value maps for AnonymousDatabaseAccessMode.
Enum value maps for AuthenticationType.
Enum value maps for AuthenticationType.
Indicates that this enum is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this enum value is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this field is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this message is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this method is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this service is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that a field MAY contain information that is sensitive and MUST be treated as such (e.g.
No description provided by the author
Identity_ServiceDesc is the grpc.ServiceDesc for Identity service.
Provisioner_ServiceDesc is the grpc.ServiceDesc for Provisioner service.
Enum value maps for S3SignatureVersion.
Enum value maps for S3SignatureVersion.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedIdentityServer should be embedded to have forward compatible implementations.
UnimplementedProvisionerServer should be embedded to have forward compatible implementations.

# Interfaces

IdentityClient is the client API for Identity service.
IdentityServer is the server API for Identity service.
ProvisionerClient is the client API for Provisioner service.
ProvisionerServer is the server API for Provisioner service.
UnsafeIdentityServer may be embedded to opt out of forward compatibility for this service.
UnsafeProvisionerServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

No description provided by the author
No description provided by the author
S3SignatureVersion is the version of the signing algorithm for all s3 requests.