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

# Packages

Package tenantcapabilities describes the privileges allotted to tenants.

# Functions

HasTenantCostControlExemption returns true if this context or one of its parent contexts was created using WithTenantCostControlExemption.
WithTenantCostControlExemption generates a child context which will cause the TenantSideKVInterceptor to ignore the respective operations.

# Constants

DefaultClusterSelectSettingName is the name of the setting that configures the default tenant to use when a client does not specify a specific tenant.
TenantIDLabel is the label used with metrics associated with a tenant.

# Variables

DefaultTenantSelect determines which tenant serves requests from clients that do not specify explicitly the tenant they want to use.
WaitForClusterStartTimeout is the amount of time the tenant controller will wait for the default virtual cluster to have an active SQL server.

# Structs

ExternalIOUsage specifies the amount of external I/O that has been consumed.
ExternalUsage contains information about usage that is not tracked through TenantSideKVInterceptor or TenantSideExternalIORecorder.

# Interfaces

TenantSideCostController is an interface through which tenant code reports and throttles resource usage.
TenantSideExternalIORecorder accounts for resources consumed when writing or reading to/from external services such as an external storage provider.
TenantSideKVInterceptor intercepts KV requests and responses, accounting for resource usage and potentially throttling requests.
TenantUsageServer is an interface through which tenant usage is reported and controlled, used on the host server side.

# Type aliases

ExternalUsageFn is a function used to retrieve usage that is not tracked through TenantSideKVInterceptor.
NextLiveInstanceIDFn is a function used to get the next live instance ID for this tenant.