package alluxio.grpc.table

Get desktop application:
View/edit binary Protocol Buffers messages

* This interface contains table master service endpoints for Alluxio clients.

• rpc GetAllDatabases (GetAllDatabasesPRequest, GetAllDatabasesPResponse)

  table_master.proto:358

  * Returns all databases in the catalog

  message GetAllDatabasesPRequest

  table_master.proto:181

  (message has no fields)

  message GetAllDatabasesPResponse

  table_master.proto:184

  • repeated string database = 1

• rpc GetAllTables (GetAllTablesPRequest, GetAllTablesPResponse)

  table_master.proto:363

  * Returns all tables in the database

  message GetAllTablesPRequest

  table_master.proto:188

  • optional string database = 1

  message GetAllTablesPResponse

  table_master.proto:192

  • repeated string table = 1

• rpc GetDatabase (GetDatabasePRequest, GetDatabasePResponse)

  table_master.proto:368

  * Gets a database by name from the table master

  message GetDatabasePRequest

  table_master.proto:196

  • optional string db_name = 1

  message GetDatabasePResponse

  table_master.proto:200

  • optional Database db = 1

• rpc GetTable (GetTablePRequest, GetTablePResponse)

  table_master.proto:373

  * Returns a specific table info

  message GetTablePRequest

  table_master.proto:204

  • optional string db_name = 1

  • optional string table_name = 2

  message GetTablePResponse

  table_master.proto:209

  • optional TableInfo table_info = 1

• rpc AttachDatabase (AttachDatabasePRequest, AttachDatabasePResponse)

  table_master.proto:378

  * Attach an existing database into the catalog as a new database name

  message AttachDatabasePRequest

  table_master.proto:213

  • optional string udb_type = 1

  • optional string udb_connection_uri = 2

  • optional string udb_db_name = 3

  • optional string db_name = 4

  • map<string, string> options = 5

  • optional bool ignore_sync_errors = 6

  message AttachDatabasePResponse

  table_master.proto:222

  • optional bool success = 1

    TODO(gpang): remove in favor of status

  • optional SyncStatus sync_status = 2

• rpc DetachDatabase (DetachDatabasePRequest, DetachDatabasePResponse)

  table_master.proto:383

  * Detach existing database into the catalog, removing any metadata about the table

  message DetachDatabasePRequest

  table_master.proto:228

  • optional string db_name = 1

  message DetachDatabasePResponse

  table_master.proto:232

  • optional bool success = 1

• rpc SyncDatabase (SyncDatabasePRequest, SyncDatabasePResponse)

  table_master.proto:388

  * Sync existing database into the catalog

  message SyncDatabasePRequest

  table_master.proto:236

  • optional string db_name = 1

  message SyncDatabasePResponse

  table_master.proto:240

  • optional bool success = 1

    TODO(gpang): remove in favor of status

  • optional SyncStatus status = 2

• rpc GetTableColumnStatistics (GetTableColumnStatisticsPRequest, GetTableColumnStatisticsPResponse)

  table_master.proto:390

  message GetTableColumnStatisticsPRequest

  table_master.proto:250

  • optional string db_name = 1

  • optional string table_name = 2

  • repeated string col_names = 3

  message GetTableColumnStatisticsPResponse

  table_master.proto:263

  • repeated ColumnStatisticsInfo statistics = 1

• rpc GetPartitionColumnStatistics (GetPartitionColumnStatisticsPRequest, GetPartitionColumnStatisticsPResponse)

  table_master.proto:392

  message GetPartitionColumnStatisticsPRequest

  table_master.proto:256

  • optional string db_name = 1

  • optional string table_name = 2

  • repeated string col_names = 3

  • repeated string part_names = 4

  message GetPartitionColumnStatisticsPResponse

  table_master.proto:270

  • map<string, ColumnStatisticsList> partition_statistics = 1

• rpc ReadTable (ReadTablePRequest, ReadTablePResponse)

  table_master.proto:394

  message ReadTablePRequest

  table_master.proto:313

  • optional string db_name = 1

  • optional string table_name = 2

  • optional Constraint constraint = 3

  message ReadTablePResponse

  table_master.proto:319

  • repeated Partition partitions = 1

• rpc TransformTable (TransformTablePRequest, TransformTablePResponse)

  table_master.proto:396

  message TransformTablePRequest

  table_master.proto:323

  • optional string db_name = 1

  • optional string table_name = 2

  • optional string definition = 3

  message TransformTablePResponse

  table_master.proto:329

  • optional int64 job_id = 1

• rpc GetTransformJobInfo (GetTransformJobInfoPRequest, GetTransformJobInfoPResponse)

  table_master.proto:403

  * Gets information of transformation jobs. If the job ID exists in the request, the information for that job is returned; Otherwise, information of all the jobs kept in table master will be returned.

  message GetTransformJobInfoPRequest

  table_master.proto:333

  • optional int64 job_id = 1

  message GetTransformJobInfoPResponse

  table_master.proto:346

  • repeated TransformJobInfo info = 1

Used in: Domain

• optional bool all = 1

Used in: ColumnStatisticsData

• optional int64 max_col_len = 1

• optional double avg_col_len = 2

• optional int64 num_nulls = 3

• optional string bit_vectors = 4

Used in: ColumnStatisticsData

• optional int64 num_trues = 1

• optional int64 num_falses = 2

• optional int64 num_nulls = 3

• optional string bit_vectors = 4

Used in: ColumnStatisticsInfo

• oneof data

  • BooleanColumnStatsData boolean_stats = 1

  • LongColumnStatsData long_stats = 2

  • DoubleColumnStatsData double_stats = 3

  • StringColumnStatsData string_stats = 4

  • BinaryColumnStatsData binary_stats = 5

  • DecimalColumnStatsData decimal_stats = 6

  • DateColumnStatsData date_stats = 7

Used in: ColumnStatisticsList, FileStatistics, GetTableColumnStatisticsPResponse, Layout, proto.journal.AddTableEntry

• optional string col_name = 1

• optional string col_type = 2

• optional ColumnStatisticsData data = 3

Used in: GetPartitionColumnStatisticsPResponse

• repeated ColumnStatisticsInfo statistics = 1

Used in: ReadTablePRequest

• map<string, Domain> column_constraints = 1

  maps column to constraint, columns not present are not constrained

Used in: GetDatabasePResponse

• optional string db_name = 1

• optional string description = 2

• optional string location = 3

• map<string, string> parameter = 4

• optional string owner_name = 5

• optional PrincipalType owner_type = 6

• optional string comment = 7

Used in: DateColumnStatsData

• required int64 days_since_epoch = 1

Used in: ColumnStatisticsData

• optional Date low_value = 1

• optional Date high_value = 2

• optional int64 num_nulls = 3

• optional int64 num_distincts = 4

• optional string bit_vectors = 5

Used in: DecimalColumnStatsData

• required int32 scale = 1

  force using scale first in Decimal.compareTo

• required bytes unscaled = 2

Used in: ColumnStatisticsData

• optional Decimal low_value = 1

• optional Decimal high_value = 2

• optional int64 num_nulls = 3

• optional int64 num_distincts = 4

• optional string bit_vectors = 5

Used in: Constraint

• oneof value_set

  • RangeSet range = 1

  • EquatableValueSet equatable = 2

  • AllOrNoneSet all_or_none = 3

Used in: ColumnStatisticsData

• optional double low_value = 1

• optional double high_value = 2

• optional int64 num_nulls = 3

• optional int64 num_distincts = 4

• optional string bit_vectors = 5

Used in: Domain

• repeated Value candidates = 1

• optional bool white_list = 2

Used in: Schema, TableInfo, layout.PartitionInfo, proto.journal.AddTableEntry

• optional uint32 id = 1

• optional string name = 2

• optional string type = 3

• optional string comment = 4

• map<string, ColumnStatisticsInfo> column = 1

  map column names to column statistics

Used in: Partition, TableInfo, Transformation, proto.journal.AddTableEntry, proto.journal.AddTransformJobInfoEntry, proto.journal.CompleteTransformTableEntry

• optional string layout_type = 1

• optional LayoutSpec layout_spec = 2

• optional bytes layout_data = 3

• map<string, ColumnStatisticsInfo> stats = 4

TODO(gpang): update

Used in: Layout

• optional string spec = 1

Used in: ColumnStatisticsData

• optional int64 low_value = 1

• optional int64 high_value = 2

• optional int64 num_nulls = 3

• optional int64 num_distincts = 4

• optional string bit_vectors = 5

next available id: 6

Used in: ReadTablePResponse, proto.journal.AddTableEntry, proto.journal.AddTablePartitionsEntry

• optional PartitionSpec partition_spec = 1

• optional Layout base_layout = 2

• repeated Transformation transformations = 3

  * The latest transformation is in the back of the list.

• optional int64 version = 4

• optional int64 version_creation_time = 5

TODO(gpang): update

Used in: Partition

• optional string spec = 1

Used in: Database, proto.journal.UpdateDatabaseInfoEntry

• USER = 0

• ROLE = 1

Used in: RangeSet

• optional Value low = 1

• optional Value high = 2

Used in: Domain

• repeated Range ranges = 1

Used in: TableInfo, proto.journal.AddTableEntry

• repeated FieldSchema cols = 1

Used in: ColumnStatisticsData

• optional int64 max_col_len = 1

• optional double avg_col_len = 2

• optional int64 num_nulls = 3

• optional int64 num_distincts = 4

• optional string bit_vectors = 5

Used in: AttachDatabasePResponse, SyncDatabasePResponse

• map<string, string> tables_errors = 1

• repeated string tables_ignored = 2

• repeated string tables_unchanged = 3

• repeated string tables_updated = 4

• repeated string tables_removed = 5

next available id: 12

Used in: GetTablePResponse

• optional string db_name = 1

• optional string table_name = 2

• optional TableInfo.TableType type = 3

• optional string owner = 4

• optional Schema schema = 5

• optional Layout layout = 6

• map<string, string> parameters = 7

• repeated FieldSchema partition_cols = 8

  partitioning scheme

• optional int64 previous_version = 9

• optional int64 version = 10

• optional int64 version_creation_time = 11

Used in: TableInfo

• NATIVE = 0

• IMPORTED = 1

Used in: GetTransformJobInfoPResponse

• optional string db_name = 1

• optional string table_name = 2

• optional string definition = 3

• optional int64 job_id = 4

• optional job.Status job_status = 5

• optional string job_error = 6

Used in: Partition

• optional Layout layout = 1

• optional string definition = 2

Used in: EquatableValueSet, Range

• oneof value

  • int64 long_type = 1

  • double double_type = 2

  • string string_type = 3

  • bool boolean_type = 4