package
20.2.19+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Packages

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

# Functions

AccessIsWithExplicitAuth checks if the provided ExternalStorage URI has explicit authentication i.e does not rely on implicit machine credentials to access the resource.
ExternalStorageConfFromURI generates an ExternalStorage config from a URI string.
ExternalStorageFromURI returns an ExternalStorage for the given URI.
GetDefaultQualifiedTableName returns the default table name for userfile tables, when the user has not specified a custom table prefix.
JoinPathPreservingTrailingSlash wraps path.Join but preserves the trailing slash if there was one in the suffix.
MakeAWSKMS is the factory method which returns a configured, ready-to-use AWS KMS object.
MakeExternalStorage creates an ExternalStorage from the given config.
MakeHTTPStorage returns an instance of HTTPStorage ExternalStorage.
MakeLocalStorageURI converts a local path (should always be relative) to a valid nodelocal URI.
MakeS3Storage returns an instance of S3 ExternalStorage.
MakeSQLConnFileTableStorage returns an instance of a FileTableStorage which uses a network connection backed SQL executor.
MakeUserFileStorageURI converts a qualified table name and filename to a valid userfile URI.
ParseWorkloadConfig parses a workload config URI to a proto config.
RedactKMSURI redacts the Master Key ID and the ExternalStorage secret credentials.
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.
TestingMakeLocalStorage is used by tests.
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.
AuthParamDefault is the query parameter for the default authentication mode in a URI.
AuthParamImplicit is the query parameter for the implicit authentication mode in a URI.
AuthParamSpecified is the query parameter for the specified authentication mode in a URI.
AWSAccessKeyParam is the query parameter for access_key in an AWS URI.
AWSEndpointParam is the query parameter for the 'endpoint' in an AWS URI.
AWSSecretParam is the query parameter for the 'secret' in an AWS URI.
AWSServerSideEncryptionKMSID is the query parameter in an AWS URI, for the KMS ID to be used for server side encryption.
AWSServerSideEncryptionMode is the query parameter in an AWS URI, for the mode to be used for server side encryption.
AWSTempTokenParam is the query parameter for session_token in an AWS 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.
CloudstorageGSDefaultKey is the setting whose value is the JSON key to use during Google Cloud Storage operations.
CloudstorageHTTPCASetting is the setting whose value is the custom root CA (appended to system's default CAs) for verifying certificates when interacting with HTTPS storage.
CredentialsParam is the query parameter for the base64-encoded contents of the Google Application Credentials JSON file.
DefaultUserfileScheme is the default scheme used in a userfile URI.
GoogleBillingProjectParam is the query parameter for the billing project in a gs URI.
KMSRegionParam is the query parameter for the 'region' in every KMS URI.
MaxDelayedRetryAttempts is the number of times the delayedRetry method will re-run the provided function.
S3RegionParam is the query parameter for the 'endpoint' in an S3 URI.

# Variables

ErrFileDoesNotExist is a sentinel error for indicating that a specified bucket/object/key/file (depending on storage terminology) does not exist.
ErrListingUnsupported is a marker for indicating listing is unsupported.
GcsDefault is the setting which defines the JSON key to use during GCS operations.
HTTPRetryOptions defines the tunable settings which control the retry of HTTP operations.