package
20.1.0-beta.2+incompatible
Repository: https://github.com/jbowens/cockroach.git
Documentation: pkg.go.dev

# Functions

ExternalStorageConfFromURI generates an ExternalStorage config from a URI string.
ExternalStorageFromURI returns an ExternalStorage for the given URI.
MakeExternalStorage creates an ExternalStorage from the given config.
MakeLocalStorageURI converts a local path (should always be relative) to a valid nodelocal URI.
ParseWorkloadConfig parses a workload config URI to a proto config.
SanitizeExternalStorageURI returns the external storage URI with with some secrets redacted, for use when showing these URIs in the UI, to provide some protection from shoulder-surfing.
URINeedsGlobExpansion checks if URI can be expanded by checking if it contains wildcard characters.

# Constants

AuthParam is the query parameter for the cluster settings named key in a URI.
AzureAccountKeyParam is the query parameter for account_key in an azure URI.
AzureAccountNameParam is the query parameter for account_name in an azure URI.
CredentialsParam is the query parameter for the base64-encoded contents of the Google Application Credentials JSON file.
GoogleBillingProjectParam is the query parameter for the billing project in a gs URI.
S3AccessKeyParam is the query parameter for access_key in an S3 URI.
S3EndpointParam is the query parameter for the 'endpoint' in an S3 URI.
S3RegionParam is the query parameter for the 'endpoint' in an S3 URI.
S3SecretParam is the query parameter for the 'secret' in an S3 URI.
S3TempTokenParam is the query parameter for session_token in an S3 URI.

# Interfaces

ExternalStorage provides functions to read and write files in some storage, namely various cloud storage providers, for example to store backups.

# Type aliases

ExternalStorageFactory describes a factory function for ExternalStorage.
ExternalStorageFromURIFactory describes a factory function for ExternalStorage given a URI.