# README
Couchbase Go Columnar Client
Not supported, in development.
# Functions
BufferQueryResult will buffer all rows in the result set into memory and return them as a slice, with any metadata.
DefaultStdioLogger gets the default standard I/O logger.
Identifier returns a string representation of the current SDK identifier.
NewCluster creates a new Cluster instance.
NewClusterOptions creates a new instance of ClusterOptions.
NewCredential creates a new Credential with the specified username and password.
NewJSONUnmarshaler creates a new JSONUnmarshaler.
NewQueryOptions creates a new instance of QueryOptions.
NewSecurityOptions creates a new instance of SecurityOptions.
NewTimeoutOptions creates a new instance of TimeoutOptions.
SetLogger sets a logger to be used by the library.
SetLogRedactionLevel specifies the level with which logs should be redacted.
VerboseStdioLogger is a more verbose level of DefaultStdioLogger().
Version returns a string representation of the current SDK version.
# Constants
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
QueryScanConsistencyNotBounded indicates no data consistency is required.
QueryScanConsistencyRequestPlus indicates that request-level data consistency is required.
RedactFull indicates to fully redact all possible identifying information from logs.
RedactNone indicates to perform no redactions.
RedactPartial indicates to redact all possible user-identifying information from logs.
# Variables
ErrClosed occurs when an entity was used after it was closed.
ErrColumnar is the base error for any Columnar error that is not captured by a more specific error.
ErrInvalidArgument occurs when an invalid argument is provided to a function.
ErrInvalidCredential occurs when invalid credentials are provided leading to errors in things like authentication.
ErrQuery occurs when a server error is encountered while executing a query, excluding errors that caught by ErrInvalidCredential or ErrTimeout.
ErrTimeout occurs when a timeout is reached while waiting for a response.
ErrUnmarshal occurs when an entity could not be unmarshalled.
# Structs
Cluster is the main entry point for the SDK.
ClusterOptions specifies options for configuring the cluster.
ColumnarError occurs when an error is encountered while interacting with the Columnar service.
Credential provides a way to specify credentials to the SDK.
Database represents a Columnar database and provides access to Scope.
JSONUnmarshaler is an Unmarshaler that performs JSON unmarshalling.
QueryError occurs when an error is returned in the errors field of the response body of a response from the query server.
QueryMetadata provides access to the meta-data properties of a query result.
QueryMetrics encapsulates various metrics gathered during a queries execution.
QueryOptions is the set of options available to an Analytics query.
QueryResult allows access to the results of a query.
QueryResultRow encapsulates a single row of a query result.
QueryWarning encapsulates any warnings returned by a query.
Scope represents a Columnar scope.
SecurityOptions specifies options for controlling security related items such as TLS root certificates and verification skipping.
TimeoutOptions specifies options for various operation timeouts.
TrustOnlyCapella tells the SDK to trust only the Capella CA certificate(s) bundled with the SDK.
TrustOnlyCertificates tells the SDK to trust only the specified certificates.
TrustOnlyPemFile tells the SDK to trust only the PEM-encoded certificate(s) in the file at the given FS path.
TrustOnlyPemString tells the SDK to trust only the PEM-encoded certificate(s) in the given string.
TrustOnlySystem tells the SDK to trust only the certificates trusted by the system cert pool.
UserPassPair represents a username and password pair.
# Interfaces
Logger defines a logging interface.
TrustOnly specifies the trust mode to use within the SDK.
Unmarshaler provides a way to unmarshal data into a Go value.
# Type aliases
LogLevel specifies the severity of a log message.
LogRedactLevel specifies the degree with which to redact the logs.
QueryScanConsistency indicates the level of data consistency desired for an analytics query.