TcaplusDB User Guide
What Is TcaplusDB?
Basic Concepts
App
Game Zone (Zone, Table Group)
TDR Table
PB Table
Generic Table and List Table
Local Index
Local TopN Index
Distributed Index (Global Index)
Typical Application Scenarios
Server Merging
Backup & Rollback
Data Backup
Record Rollback
Table Rollback
Process Rollback
Conditional Rollback
Optimistic Lock
Schema Free
Data Expiration
Database Selection Reference
TcaplusDB Environment Preparation
Tencent Cloud Service Application
Local Environment Deployment
Container Environment Deployment
Introduction to TcaplusDB
Follow-up Operations
TcaplusDB OMS Console
App Management
Step 1: Create an App
View the App ID
View the Directory Server Address
View the App Access Password
Game Zone (Table Group) Management
Step 2: Create a Game Zone
Modify the Game Zone (Table Group)
View the Game Zone ID (Table Group)
Batch Copy Game Zones (Table Group)
Modify the Client Whitelist Configuration
Table Management
Step 3: Create a Table
Modify a Table
Delete a Table
Truncate a Table
Rebuild a Table
Set Table Compression
Set Read Shunt
Set Data Expiration
Set Write Buffer
Step 9: Create a Distributed Index (Global Index)
Data Management
View Data
TcaplusDB SDK & API
TDR Table SDK & API
C++ SDK
Get Started
Interface Documents
[Generic Table] Get a Record
[Generic Table] Insert a Record
[Generic Table] Replace a Record
[Generic Table] Delete a Record
[Generic Table] Query Local Index
[Generic Table] Query Distributed Index (Global Index)
[Generic Table] Batch Insert Multiple Records
[Generic Table] Batch Update Multiple Records
[Generic Table] Batch Replace Multiple Records
[Generic Table] Batch Delete Multiple Records
[Generic Table] Traverse Table Data
[Generic Table] Auto-increment of Part Fields
[Generic Table] Set Record Expiration
[Generic Table] Get Record Expiration
[List Table] Insert an Element into a Specified Position in a List
[List Table] Get an Element from a Specified Position in a List
[List Table] Replace an Element to a Specified Position in a List
[List Table] Delete an Element from a Specified Position in a List
[List Table] Get All Elements from a List
[List Table] Delete All Elements from a List
[List Table] Batch Insert Elements into a List
[List Table] Batch Get Elements from a List
[List Table] Batch Replace Elements to a List
[List Table] Batch Delete Elements from a List
[List Table] Traverse Table Data
[Generic Table] Batch Delete Records through Local Index
Get the Total Number of Table Records
Response to subcontracting issues description
Conditional Filter and Update
FAQ
Java SDK
Get Started
Interface Documents
[Generic Table] Get a Record
[Generic Table] Query Local Index
[Generic Table] Traverse Full Table Data
[Generic Table] Batch Get Multiple Records
[Generic Table] Insert a Record
[Generic Table] Replace a Record
[Generic Table] Update a Record
[Generic Table] Auto-increment of Fields in a Record
[Generic Table] Delete a Record
[List Table] Get All Elements from a List
[List Table] Get an Element from a Specified Position in a List
[List Table] Traverse Full Table Data
[List Table] Insert an Element into a Specified Position in a List
[List Table] Replace an Element to a Specified Position in a List
[List Table] Delete All Elements from a List
[List Table] Delete an Element from a Specified Position in a List
[List Table] Batch Delete Elements from a List
Get Table Structure
FAQ
About Data Type
Go SDK
Get Started
Interface Documents
[Generic Table] Get a Record
[Generic Table] Insert a Record
[Generic Table] Update a Record
[Generic Table] Replace a Record
[Generic Table] Delete a Record
[Generic Table] Query Local Index
[Generic Table] Query Distributed Index
[Generic Table] Batch Get Multiple Records
[Generic Table] Batch Insert Multiple Records
[Generic Table] Batch Update Multiple Records
[Generic Table] Batch Replace Multiple Records
[Generic Table] Batch Delete Multiple Records
[Generic Table] Traverse Table Data
[Generic Table] Auto-increment of Part Fields
[Generic Table] Set Record Expiration
[Generic Table] Get Record Expiration
[List Table] Insert an Element into a Specified Position in a List
[List Table] Get an Element from a Specified Position in a List
[List Table] Replace an Element to a Specified Position in a List
[List Table] Delete an Element from a Specified Position in a List
[List Table] Get All Elements from a List
[List Table] Delete All Elements from a List
[List Table] Batch Insert Elements into a List
[List Table] Batch Get Elements from a List
[List Table] Batch Replace Elements to a List
[List Table] Batch Delete Elements from a List
[List Table] Traverse Table Data
[Generic Table] Batch Delete Records through Local Index
Get the Total Number of Table Records
MySQL Protocol Compatibility Interface
Get Started
Syntax Description
[Generic Table] Insert Records
[Generic Table] Delete Records
[Generic Table] Update a Record
[Generic Table] Get Records
[Generic Table] Traverse Full Table
[Generic Table] COUNT
[Generic Table] Optimistic Lock
[Generic Table] TTL
[Generic Table] Query Global Index
[Generic Table] Query Local TopN Index
About Data Type
Get Access Information
Read/Write Permission Management
MySQL Protocol Compatibility Error Code
PB Table SDK & API
C++ SDK
Get Started
Interface Documents
[Generic Table] Get a Record
[Generic Table] Insert a Record
[Generic Table] Update a Record
[Generic Table] Replace a Record
[Generic Table] Delete a Record
[Generic Table] Query Local Index
[Generic Table] Query Global Index
[Generic Table] Batch Get Multiple Records
[Generic Table] Batch Insert Multiple Records
[Generic Table] Batch Update Multiple Records
[Generic Table] Batch Replace Multiple Records
[Generic Table] Batch Delete Multiple Records
[Generic Table] Traverse Table Data
[Generic Table] Get Part Fields
[Generic Table] Update Part Fields
[Generic Table] Auto-increment of Part Fields
[Generic Table] Record Expiration
[List Table] Insert an Element into a Specified Position in a List
[List Table] Get an Element from a Specified Position in a List
[List Table] Replace an Element to a Specified Position in a List
[List Table] Delete an Element from a Specified Position in a List
[List Table] Get All Elements from a List
[List Table] Delete All Elements from a List
[List Table] Batch Insert Elements into a List
[List Table] Batch Get Elements from a List
[List Table] Batch Replace Elements to a List
[List Table] Batch Delete Elements from a List
[List Table] Traverse Table Data
[Generic Table] Batch Delete Records through Local Index
Get the Total Number of Table Records
Conditional Filter and Update
Go SDK
Get Started
Interface Documents
[Generic Table] Get a Record
[Generic Table] Insert a Record
[Generic Table] Update a Record
[Generic Table] Replace a Record
[Generic Table] Delete a Record
[Generic Table] Get Part Fields
[Generic Table] Update Part Fields
[Generic Table] Auto-increment of Part Fields
[Generic Table] Query Local Index
[Generic Table] Query Distributed Index (Global Index)
[Generic Table] Batch Get Multiple Records
[Generic Table] Batch Insert Multiple Records
[Generic Table] Batch Update Multiple Records
[Generic Table] Batch Replace Multiple Records
[Generic Table] Batch Delete Multiple Records
[Generic Table] Traverse Table Data
[Generic Table] Set Record Expiration
[Generic Table] Get Record Expiration
[List Table] Insert an Element into a Specified Position in a List
[List Table] Get an Element from a Specified Position in a List
[List Table] Replace an Element to a Specified Position in a List
[List Table] Delete an Element from a Specified Position in a List
[List Table] Get All Elements from a List
[List Table] Delete All Elements from a List
[List Table] Batch Insert Elements into a List
[List Table] Batch Get Elements from a List
[List Table] Batch Replace Elements to a List
[List Table] Batch Delete Elements from a List
[List Table] Traverse Table Data
[Generic Table] Batch Delete Records through Local Index
Get the Total Number of Table Records
Conditional Filter and Update
RESTFul API
Get Started
Interface Documents
[Generic Table] Get a Record
[Generic Table] Insert a Record
[Generic Table] Get Part Field Values of a Record
[Generic Table] Update a Record
[Generic Table] Update Part Field Values of a Record
[Generic Table] Auto-increment of Fields in a Record
[Generic Table] Replace a Record
[Generic Table] Delete a Record
[Generic Table] Delete Record with the Same Key Value of the Local Index
[Generic Table] Batch Get Multiple Records
[Generic Table] Batch Get Part Field Values of Multiple Records
[Generic Table] Batch Insert Multiple Records
[Generic Table] Batch Update Multiple Records
[Generic Table] Batch Replace Multiple Records
[Generic Table] Batch Delete Multiple Records
[Generic Table] Get Total Number of Records in a Table
[Generic Table] Query Local Index
[Generic Table] Query Distributed Index (Global Index)
[Generic Table] Traverse Table Data
[List Table] Get an Element from a List
[List Table] Get Multiple Elements from a List
[List Table] Get All Elements from a List
[List Table] Insert an Element into a List
[List Table] Insert Multiple Elements into a List
[List Table] Update an Element to a List
[List Table] Batch Update Multiple Elements to a List
[List Table] Delete an Element from a List
[List Table] Batch Delete Multiple Elements from a List
[List Table] Delete All Elements from a List
[List Table] Traverse Table Data
WebService API
Get Started
Interface Description
Authorization Certificate
Get access-token[AccessToken]
App Management
Get Zone List under the App [GetZoneList]
Get Unfinished Application List under the App [GetTableApplyListInApp]
Get IP List for Use under the App [GetIpList]
Game Zone (Table Group) Management
Add Zones [ZonesAdd]
Modify Zones [ModifiedZone]
Delete Zones [ZonesBatchDelete]
Get Table List under the Zone [TableListByZone]
Table Management
View Table Details
View Table Details [TableDetail]
Add Tables
Upload xml/tdr File Defining Table Structure [Attachment]
Check the Table Defined by the Specified xml/tdr/proto File [TdrDefinition]
Apply for Adding Tables through xml/tdr/proto File
Confirm the Application Form for Adding Tables [AddTableConfirm]
Clone the Table Structure [ZonesClone]
Modify a Table
Apply for Modifying Tables [TableModify]
Check the Application for Modifying Tables [TableModifyCheck]
Check Whether the Table Structure Has Changed [TdrModifyCheck]
Truncate Tables
Apply for Truncating Tables [TableTruncating]
Check the Application for Truncating Tables [TableTruncateCheck]
Delete Tables
Apply for Deleting Tables [TableDeleting]
Check the Application for Deleting Tables [TableDeleteCheck]
Rebuild a Table
Apply for Rebuilding Tables [TableRebuild]
Check the Application for Rebuilding Tables [TableRebuildCheck]
Set Table Data Expiration
Set Table Data Expiration [TableSetDataExpiration]
Merge Table Data
Apply for Merging Table Data [TableBatchMergeTableData]
Check the Application for Merging Table Data [TableMergeTableDataCheck]
Get Application Form Details [TableGetTableApplyDetail]
Transaction Management
Get Transaction Details [TransactionDetail]
Execute Transaction [TransactionExecuting]
Recover Transaction [TransactionRedo]
Get the Svr Failover Transaction List of the Specified App [TransactionGetFailoverList]
Data Backup Management
Apply for Data Backup Based on Tables [BackupSvrDataApply]
Apply for Blocking Data Backup [BackupSvrDataApplyBlockTimer]
Check the Application for Data Backup [BackupSvrDataCheck]
Get Application Form Details for Data Backup [BackupSvrDataApplyDetail]
Block Auto-Backup Based on Game Zones [BlockAutoBackupAdd]
Delete Auto-Backup Blocking Based on Game Zones [BlockAutoBackupDelete]
View Auto-Backup Blocking Based on Game Zones [BlockAutoBackup]
Generate Table Data Construction Transaction [TableDataMake]
Generate Machine Data Construction Transaction [MachineDataMake]
Generate Data Import Transaction [TableDataImport]
Get Data Construction Transaction [TableDataRelateTrans]
Distributed Index (Global Index) Management
Apply for Creating a Table Index [ApplyTableIndex]
Check the Application for Creating a Table Index [CheckApplyTableIndex]
Abort the Table Index Application Form [TableAbortApply]
Get Table Index Details [GetTableIndex]
Customer Mark Management
Add Customer Mark [CustomerOmsStoreAdd]
Query Customer Mark [CustomerOmsStoreQuery]
Update Customer Mark [CustomerOmsStoreUpdate]
Delete Customer Mark [CustomerOmsStoreDelete]
Client
Get Started
Command Description
Help Command
Show Command
Desc Command
Select Command (Traverse Tables)
Step 5: Query Data
Step 8: Query Local Index
Step 10: Query Distributed Index (Global Index)
Count Command
Getttl Command
Step 4: Insert Data
Step 6: Update Data
Setttl Command
Step 7: Replace Data
Step 11: Delete Data
Dump Command
Load Command
Exit Command
Quit Command
Common Errors
FAQ
Conditional Filter and Update Syntax Description
Batch Operation Interface Description
TcaplusDB Release Notes
3.55.0 Release Notes
3.62.1 Release Notes
TcaplusDB Release Version Download
TDR Table SDK Download
PB Table SDK Download
Client Download
Docker Image Download
Benchmark Tool Download
TcaplusDB FAQ
General Questions
Typical Technical Questions
Compilation Questions
Traversal and Batch Operation Related Questions
Performance Questions
OMS Console and O&M Related Questions
Client Related Questions
TcaplusDB Performance
Performance Baseline
Benchmark Tool (C++) Instructions
Benchmark Tool (Java) Instructions
TcaplusDB Error Codes
>
<
TcaplusDB User Guide
Docker Image Download
TcaplusDB Docker Image Download
Version number
Download link
3.73.1
Download
← 上一篇
Client Download
下一篇 →
Benchmark Tool Download