package tipb.tici

Get desktop application:
View/edit binary Protocol Buffers messages

IndexerService provides index creation and deletion functionality

• rpc CreateIndex (CreateIndexRequest, CreateIndexResponse)

  indexer.proto:19

  CreateIndex creates a new index

  message CreateIndexRequest

  indexer.proto:49

  CreateIndexRequest is a request to create an index

  • optional TiCIIndexInfo index_info = 1

    Index information

  • optional TiCITableInfo table_info = 2

    Table information

  message CreateIndexResponse

  indexer.proto:57

  CreateIndexResponse is a response to the index creation request

  • int32 status = 1

    Operation result status code, 0 means success

  • string error_message = 2

    Error message, only valid when status is non-zero

  • string index_id = 3

    Created index ID

• rpc DropIndex (DropIndexRequest, DropIndexResponse)

  indexer.proto:22

  DropIndex removes an existing index

  message DropIndexRequest

  indexer.proto:67

  DropIndexRequest is a request to drop an index

  • int64 table_id = 1

    Index ID

  • string index_id = 2

  message DropIndexResponse

  indexer.proto:75

  DropIndexResponse is a response to the index drop request

  • int32 status = 1

    Operation result status code, 0 means success

  • string error_message = 2

    Error message, only valid when status is non-zero

• rpc GetIndexProgress (GetIndexProgressRequest, GetIndexProgressResponse)

  indexer.proto:25

  GetIndexProgress retrieves the current progress of an index build

  message GetIndexProgressRequest

  indexer.proto:149

  GetIndexProgressRequest is a request to get the progress of an index build

  • int64 table_id = 1

    Table ID

  • int64 index_id = 2

    Index ID

  message GetIndexProgressResponse

  indexer.proto:157

  GetIndexProgressResponse is a response containing index build progress

  • int32 status = 1

    Operation result status code, 0 means success

  • string error_message = 2

    Error message, only valid when status is non-zero

  • uint64 document_count = 3

    Number of documents indexed so far

  • string state = 4

    Build task state (PENDING, RUNNING, COMPLETED, FAILED)

  • bool is_uploaded = 5

    Whether index has been uploaded to S3

  • string last_upload_time = 6

    Last S3 upload time in RFC3339 format

  • repeated string s3_path = 7

    S3 path where the index is stored

IndexType represents the type of index

Used in: TiCIIndexInfo

• UNKNOWN = 0

  Default value must be 0 in proto3

• FULL_TEXT = 1

  Full-text index type

• CUSTOM = 2

  Custom index type

ParserInfo represents parser information

Used in: TiCIIndexInfo

• ParserType parser_type = 1

  Parser type

• map<string, string> parser_params = 2

  Parser parameters

ParserType represents the type of parser

Used in: ParserInfo

• UNKNOWN_PARSER = 0

  Default value must be 0 in proto3

• DEFAULT_PARSER = 1

  Default parser

• OTHER_PARSER = 2

  Other parser types

ColumnInfo represents column information

Used in: TiCIIndexInfo, TiCITableInfo

• int64 column_id = 1

  Column ID

• string column_name = 2

  Column name

• int32 type = 3

  MySQL type

• int32 collation = 4

  Collation

• int32 column_length = 5

  Column length

• int32 decimal = 6

  Decimal places

• int32 flag = 7

  Flags

• repeated string elems = 8

  Enum elements

• bytes default_val = 9

  Default value

• bool is_primary_key = 10

  Whether it's a primary key

• bool is_array = 11

  Whether it's an array

IndexInfo represents index information

Used in: CreateIndexRequest

• int64 index_id = 1

  Index ID

• string index_name = 2

  Index name

• IndexType index_type = 3

  Index type (fulltext, custom)

• repeated TiCIColumnInfo columns = 4

  Index columns

• bool is_unique = 5

  Whether the index is unique

• optional ParserInfo parser_info = 6

  Parser information

• map<string, string> other_params = 7

  Other index parameters

TableInfo represents table information

Used in: CreateIndexRequest

• int64 table_id = 1

  Table ID

• string table_name = 2

  Table name

• string database_name = 3

  Database name

• int64 version = 4

  Table version

• repeated TiCIColumnInfo columns = 5

  Column information