package
0.0.0-20240828030039-78c4ba100686
Repository: https://github.com/yugabyte/yb-tools.git
Documentation: pkg.go.dev
# Constants
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
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
Active consensus config.
Committed consensus config.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TUPLE is not yet fully implemented, but it is a CQL type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
All unsigned datatypes will be removed from QL because databases do not have these types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Default values for ColumnSchemaPB fields.
Default values for ColumnSchemaPB fields.
Default values for ColumnSchemaPB fields.
Default values for ColumnSchemaPB fields.
Default values for ColumnSchemaPB fields.
Default values for ColumnSchemaPB fields.
Default values for ColumnSchemaPB fields.
Default values for IndexInfoPB fields.
Default values for IndexInfoPB fields.
Default values for IndexInfoPB fields.
Default values for IndexInfoPB fields.
Default values for IndexInfoPB fields.
Default values for IndexInfoPB fields.
Default values for PgsqlReadRequestPB fields.
Default values for PgsqlReadRequestPB fields.
Default values for PgsqlReadRequestPB fields.
Default values for PgsqlReadRequestPB fields.
Default values for PgsqlReadRequestPB fields.
Default values for PgsqlResponsePB fields.
Default values for PgsqlResponsePB fields.
Default values for PgsqlWriteRequestPB fields.
Default values for PgsqlWriteRequestPB fields.
Default values for PgsqlWriteRequestPB fields.
Default values for QLReadRequestPB fields.
Default values for QLReadRequestPB fields.
Default values for QLReadRequestPB fields.
Default values for QLReadRequestPB fields.
Default values for QLReadRequestPB fields.
Default values for QLResponsePB fields.
Default values for QLWriteRequestPB fields.
Default values for QLWriteRequestPB fields.
Default values for QLWriteRequestPB fields.
Default values for QLWriteRequestPB fields.
Default values for RaftGroupReplicaSuperBlockPB fields.
Default values for RaftGroupReplicaSuperBlockPB fields.
Default values for RaftGroupReplicaSuperBlockPB fields.
Default values for RaftGroupReplicaSuperBlockPB fields.
Default values for RedisAddRequestPB fields.
Default values for RedisCollectionGetRangeRequestPB fields.
Default values for RedisCollectionGetRangeRequestPB fields.
Default values for RedisGetRequestPB fields.
Default values for RedisGetTtlRequestPB fields.
Default values for RedisIncrRequestPB fields.
Default values for RedisKeyValuePB fields.
Default values for RedisPopRequestPB fields.
Default values for RedisPushRequestPB fields.
Default values for RedisPushRequestPB fields.
Default values for RedisReadRequestPB fields.
Default values for RedisSetRequestPB fields.
Default values for RedisSetRequestPB fields.
Default values for RedisSetRequestPB fields.
Default values for RedisSetTtlRequestPB fields.
Default values for RedisSubKeyBoundPB fields.
Default values for SortedSetOptionsPB fields.
Default values for SortedSetOptionsPB fields.
Default values for SortedSetOptionsPB fields.
Default values for TableInfoPB fields.
Default values for TablePropertiesPB fields.
Default values for TablePropertiesPB fields.
Default values for TablePropertiesPB fields.
Default values for TablePropertiesPB fields.
Default values for TablePropertiesPB fields.
Default values for TablePropertiesPB fields.
Default values for TransactionMetadataPB fields.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Used as a sentinel value.
This is the "success" state, where the index is completely usable.
No description provided by the author
Used while removing an index -- either due to backfill failure, or due to a client requested "drop index".
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
The -> operator applied to a column.
The ->> operator applied to a column.
No description provided by the author
No description provided by the author
This is the default order mode.
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
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
Logic operators that take two or more operands.
Relation operators that take three operands.
Relation operators that take two operands.
IF EXISTS.
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
Relation operators that take one operand.
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
Logic operators that take one operand.
No description provided by the author
No description provided by the author
IF NOT EXISTS.
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
Indicates the Raft group is bootstrapping, i.e.
The Raft group failed to for some reason.
Raft group has not yet started.
The Raft group is shutting down, and will not accept further requests.
Once the configuration phase is over Peers are in RUNNING state.
The Raft group has been stopped.
No description provided by the author
Indicates this node is a follower in the configuration, i.e.
Indicates this node is the current leader of the configuration, i.e.
New peers joining a quorum will be in this role for both PRE_VOTER and PRE_OBSERVER while the tablet data is being remote bootstrapped.
Indicates that this node is not a participant of the configuration, i.e.
Async replication mode.
Any server added into a running consensus with the intention of becoming an async replica (OBSERVER), Such a server stays as a PRE_OBSERVER (for a specific tablet) till it is remote bootstrapped, after which it is promoted to OBSERVER.
Any server added into a running consensus with the intention of becoming a VOTER, should be added as a PRE_VOTER.
This peer is a read (async) replica and gets informed of the quorum write activity and provides time-line consistent reads.
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
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
No description provided by the author
No description provided by the author
Nil is when value is not found, but isn't an error case, eg.
Not found is an error when an existing value is needed for the command, eg.
No description provided by the author
No description provided by the author
This code is set in the client to mark commands for which no response was received.
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
Obtain no tuple lock (this should never sent be on the wire).
Not supported.
Obtain exclusive tuple lock.
Obtain keyshare tuple lock.
Obtain no-key exclusive tuple lock.
Not supported.
Obtain shared tuple lock.
No description provided by the author
No description provided by the author
No description provided by the author
The tablet is set to TABLET_DATA_COPYING state when in the middle of remote bootstrap while copying data files from a remote peer.
This tablet is in the process of being deleted.
This tablet has been initialized as a subtablet of another tablet undergoing a split.
Fresh empty tablets and successfully copied tablets are set to the TABLET_DATA_READY state.
This tablet split has been completed.
The tablet has been deleted, and now just consists of a "tombstone".
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
All following entries are not used in RAFT, but as events between status tablet and involved tablets:.
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
Consistent-prefix consistency means that we always see consistent snapshot of the database in a well-defined order.
This consistency level provides Linearizability guarantees and is the default for our system.
For cross-shard transactions only: user-enforced consistency level means it is the user's responsibility to enforce consistency across shards or tables/indexes.
No description provided by the author
Pgsql database.
No description provided by the author
No description provided by the author
# Variables
Enum value maps for AppStatusPB_ErrorCode.
Enum value maps for AppStatusPB_ErrorCode.
Enum value maps for ConsensusConfigType.
Enum value maps for ConsensusConfigType.
Enum value maps for DataType.
Enum value maps for DataType.
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
Enum value maps for IndexPermissions.
Enum value maps for IndexPermissions.
Enum value maps for InvolvedTabletMetadataState.
Enum value maps for InvolvedTabletMetadataState.
Enum value maps for IsolationLevel.
Enum value maps for IsolationLevel.
Enum value maps for JsonOperatorPB.
Enum value maps for JsonOperatorPB.
Enum value maps for OrderMode.
Enum value maps for OrderMode.
Enum value maps for PartitionSchemaPB_HashBucketSchemaPB_HashAlgorithm.
Enum value maps for PartitionSchemaPB_HashBucketSchemaPB_HashAlgorithm.
Enum value maps for PartitionSchemaPB_HashSchema.
Enum value maps for PartitionSchemaPB_HashSchema.
Enum value maps for PermissionType.
Enum value maps for PermissionType.
Enum value maps for PgsqlResponsePB_RequestStatus.
Enum value maps for PgsqlResponsePB_RequestStatus.
Enum value maps for PgsqlWriteRequestPB_PgsqlStmtType.
Enum value maps for PgsqlWriteRequestPB_PgsqlStmtType.
Enum value maps for QLClient.
Enum value maps for QLClient.
Enum value maps for QLOperator.
Enum value maps for QLOperator.
Enum value maps for QLResponsePB_QLStatus.
Enum value maps for QLResponsePB_QLStatus.
Enum value maps for QLVirtualValuePB.
Enum value maps for QLVirtualValuePB.
Enum value maps for QLWriteRequestPB_QLStmtType.
Enum value maps for QLWriteRequestPB_QLStmtType.
Enum value maps for RaftGroupStatePB.
Enum value maps for RaftGroupStatePB.
Enum value maps for RaftPeerPB_MemberType.
Enum value maps for RaftPeerPB_MemberType.
Enum value maps for RaftPeerPB_Role.
Enum value maps for RaftPeerPB_Role.
Enum value maps for RedisCollectionGetRangeRequestPB_GetRangeRequestType.
Enum value maps for RedisCollectionGetRangeRequestPB_GetRangeRequestType.
Enum value maps for RedisDataType.
Enum value maps for RedisDataType.
Enum value maps for RedisGetRequestPB_GetRequestType.
Enum value maps for RedisGetRequestPB_GetRequestType.
Enum value maps for RedisOrder.
Enum value maps for RedisOrder.
Enum value maps for RedisResponsePB_RedisStatusCode.
Enum value maps for RedisResponsePB_RedisStatusCode.
Enum value maps for RedisSide.
Enum value maps for RedisSide.
Enum value maps for RedisSubKeyBoundPB_InfinityType.
Enum value maps for RedisSubKeyBoundPB_InfinityType.
Enum value maps for RedisWriteMode.
Enum value maps for RedisWriteMode.
Enum value maps for ResourceType.
Enum value maps for ResourceType.
Enum value maps for RowMarkType.
Enum value maps for RowMarkType.
Enum value maps for SortedSetOptionsPB_UpdateOptions.
Enum value maps for SortedSetOptionsPB_UpdateOptions.
Enum value maps for TabletDataState.
Enum value maps for TabletDataState.
Enum value maps for TableType.
Enum value maps for TableType.
Enum value maps for TransactionStatus.
Enum value maps for TransactionStatus.
Enum value maps for YBConsistencyLevel.
Enum value maps for YBConsistencyLevel.
Enum value maps for YQLDatabase.
Enum value maps for YQLDatabase.
# Structs
Error status returned by any RPC method.
No description provided by the author
No description provided by the author
For clarification of field meaning see comments of appropriate fields in YBTransaction::Impl.
For clarification of field meaning see comments of appropriate fields in YBTransaction::Impl.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO: Differentiate between the schema attributes that are only relevant to the server (e.g., encoding and compression) and those that also matter to the client.
This PB is used to serialize all of the persistent state needed for Consensus that is not in the WAL, such as leader election and communication on startup.
Represents a snapshot of a configuration at a given moment in time.
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
This message contains the metadata of a secondary index of a table.
Index column mapping.
No description provided by the author
KV-store meta data.
Uniquely identify a particular instance of a particular server in the cluster.
The serialized format of a YB table partition.
The serialized format of a YB table partition schema.
A column identifier for partition schemas.
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
This message defines an argument in a batch request from PgGate to DocDB.
-------------------------------------------------------------------------------------------------- Expressions.-------------------------------------------------------------------------------------------------- Builtin call expression.
-------------------------------------------------------------------------------------------------- Column messages.-------------------------------------------------------------------------------------------------- ColumnRefs is a list of columns to be read by DocDB before a PGSQL request can be executed.
ColumnValue is a value to be assigned to a table column by DocDB while executing a PGSQL request.
A logical condition that evaluates to true/false.
An expression in a WHERE condition.
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
Paging state for continuing a read request.
Boundary value.
TODO(neil) The protocol for select needs to be changed accordingly when we introduce and cache execution plan in tablet server.
Response from tablet server for both read and write.
PgsqlRSColDesc is the descriptor of a selected column in a ResultSet (RS), which can be any expression and not just table columns.
Descriptor of a row in a resultset (RS).
Instruction.
Builtin call expression.
A column value, optionally with subscripts, e.g.
A logical condition that evaluates to true/false.
An expression in a WHERE condition.
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
Represents operations applied to a json column.
No description provided by the author
No description provided by the author
Paging state for continuing a read request.
TODO(neil) The protocol for select needs to be changed accordingly when we introduce and cache execution plan in tablet server.
These columns must be read by DocDB before a read or write request can be executed.
No description provided by the author
QLRSColDesc is the descriptor of a SELECT'ed column in a ResultSet, which can be any expression and not just table columns.
Descriptor of a row in a resultset.
Sequence of values used to represent Lists and Sets (and later Tuples).
Reference to a subcolumn, e.g.
No description provided by the author
Fields for user-defined types.
A QL value.
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
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
A set of peers, serving a single tablet.
The super-block keeps track of the Raft group.
A peer in a configuration.
See ReadHybridTime for explation of this message.
SADD.
APPEND.
No description provided by the author
No description provided by the author
DEL, HDEL.
EXISTS, HEXISTS.
RENAME.
GETRANGE.
GET, HGET, MGET, HMGET, HGETALL, SMEMBERS HKEYS, HKEYS, HLEN.
GETSET.
TTL, PTTL.
INCR, INCRBY, INCRBYFLOAT, HINCRBY, HINCRBYFLOAT, ZINCRBY, DECR, DECRBY, ZADD with incr option.
No description provided by the author
No description provided by the author
LINSERT.
KEYS.
- Even if just a key is needed, or there are multiple values, this is used.
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 operation.
LPOP, RPOP, SPOP; blocking versions BLPOP etc.
RPUSH, RPUSHX, LPUSH, LPUSHX.
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
SETRANGE.
SET, SETNX, SETXX, HSET, HSETNX, LSET, MSET, HMSET, MSETNX.
PERSIST, (P)EXPIRE, (P)EXPIREAT.
No description provided by the author
No description provided by the author
STRLEN, HSTRLEN.
Wrapper for a subkey which denotes an upper/lower bound for a range request.
No description provided by the author
A single Redis request.
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
RPC and HTTP addresses for each server, as well as cloud related information.
No description provided by the author
No description provided by the author
Table information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
To ensure compatibility between release versions, the numeric values of these datatypes cannot be changed once the types are implemented and released.
Indexes when created or deleted go through a series of steps to add a) delete, b) write and c) read permissions one by one.
No description provided by the author
No description provided by the author
No description provided by the author
The possible order modes for clients.
No description provided by the author
No description provided by the author
Suffixed with PERMISSION, because Google does not allow same enum name CREATE.
Response status.
Statement types.
Client type.
Expression operators.
Response status.
-------------------------------------------------------------------------------------------------- YQL support.
Statement types.
The enum of Raft group states.
No description provided by the author
The possible roles for peers.
No description provided by the author
No description provided by the author
No description provided by the author
This enum is used to specify the insertion position (Insert after or before index).
No description provided by the author
This enum is used to specify the side of a list (For LPOP or RPOP etc.).
No description provided by the author
No description provided by the author
Used for Cassandra Roles and Permissions.
This enum matches enum RowMarkType defined in src/include/nodes/plannodes.h.
No description provided by the author
State flags indicating whether the tablet is in the middle of being copied and is therefore not possible to bring up, whether it has been deleted, or whether the data is in a usable state.
This must exactly match YBTableType in client.h.
No description provided by the author
No description provided by the author
Client type.