Module catalog

Re-exports

• pub use crate::constants::hummock;

Modules

• column 🔒
• external_table 🔒
• internal_table 🔒
• physical_table 🔒
• schema 🔒
• schema_test_utils
• test_utils

Structs

• CdcTableDesc
  Necessary information for compute node to access data in the external database. Compute node will use this information to connect to the external database and scan the table.
• ColumnCatalog
• ColumnDesc
• ColumnId
  Column ID is the unique identifier of a column in a table. Different from table ID, column ID is not globally unique.
• ConnectionId
• DatabaseId
• Field
  The field in the schema of the executor’s return data
• FieldDisplay
• FunctionId
• IndexId
• Schema
  the schema of the executor’s return data
• SchemaId
• SecretId
• TableDesc
  Includes necessary information for compute node to access data of the table.
• TableId
• TableOption
• UserId

Enums

• ConflictBehavior
• CreateType
• StreamJobStatus
• SystemColumn

Constants

• CDC_SOURCE_COLUMN_NUM
• DEFAULT_DATABASE_NAME
• DEFAULT_KEY_COLUMN_NAME
• DEFAULT_SCHEMA_NAME
• DEFAULT_SUPER_USER
• DEFAULT_SUPER_USER_FOR_PG
• DEFAULT_SUPER_USER_FOR_PG_ID
• DEFAULT_SUPER_USER_ID
• INFORMATION_SCHEMA_SCHEMA_NAME
• INITIAL_SOURCE_VERSION_ID
  The default version ID for a new source.
• INITIAL_TABLE_VERSION_ID
  The default version ID for a new table.
• KAFKA_TIMESTAMP_COLUMN_NAME
  For kafka source, we attach a hidden column KAFKA_TIMESTAMP_COLUMN_NAME to it, so that we can limit the timestamp range when querying it directly with batch query. The column type is DataType::Timestamptz. For more details, please refer to this rfc.
• MAX_SYS_CATALOG_NUM
• NON_RESERVED_USER_ID
• OBJECT_ID_PLACEHOLDER
• OFFSET_COLUMN_NAME
• PG_CATALOG_SCHEMA_NAME
• RESERVED_PG_SCHEMA_PREFIX
• ROWID_PREFIX
• ROW_ID_COLUMN_ID
  The column ID preserved for the row ID column.
• RW_CATALOG_SCHEMA_NAME
• RW_INTERNAL_TABLE_FUNCTION_NAME
• RW_RESERVED_COLUMN_NAME_PREFIX
• RW_TIMESTAMP_COLUMN_ID
• RW_TIMESTAMP_COLUMN_NAME
• SYSTEM_SCHEMAS
• SYS_CATALOG_START_ID
• TABLE_NAME_COLUMN_NAME
• USER_COLUMN_ID_OFFSET
  The column ID offset for user-defined columns.

Traits

• SysCatalogReader
  The local system catalog reader in the frontend node.

Functions

• cdc_table_name_column_desc
  A column to store the upstream table name of the cdc table
• columns_extend
• debug_assert_column_ids_distinct
• default_key_column_name_version_mapping
• generate_internal_table_name_with_type
• get_dist_key_in_pk_indices
• get_dist_key_start_index_in_pk
  Get distribution key start index in pk, and return None if dist_key_in_pk_indices is not empty or continuous. Note that dist_key_in_pk_indices may be shuffled, the start index should be the minimum value.
• is_offset_column_name
• is_row_id_column_name
• is_system_schema
• max_column_id
  FIXME: perhapts we should use sth like ColumnIdGenerator::new_alter, However, the SourceVersion is problematic: It doesn’t contain next_col_id. (But for now this isn’t a large problem, since drop column is not allowed for source yet..)
• offset_column_desc
  Creates a offset column for storing upstream offset Used in cdc source currently
• row_id_column_desc
  Creates a row ID column (for implicit primary key). It’ll always have the ID 0 for now.
• rw_timestamp_column_desc
• valid_table_name

Type Aliases

• CatalogVersion
  The global version of the catalog.
• ObjectId
• SourceVersionId
  The version number of the per-source catalog.
• SysCatalogReaderRef
• TableVersionId
  The version number of the per-table catalog.