All Products
Search
Document Center

Tablestore:PHP SDK

Last Updated:Jun 19, 2025

Tablestore PHP SDK supports operations on the Wide Column model.

Feature list

Before you use the SDK features, you need to initialize a client. The following table describes the features supported by Tablestore PHP SDK.

Feature type

Operation

Description

Data table operations

Create a data table

Create a data table to store data. You can configure auto-increment primary key columns when you create a data table.

Update table configurations

Updates the configurations of a data table.

List data tables

View the names of all data tables in an instance.

Query table information

Queries the configurations of a data table.

Delete a data table

You can delete a data table.

Data operations

Write data

Write data to the data table.

Read data

Read data from the data table.

Delete data

Delete data from the data table.

Filter

Filter the read results on the server side based on the conditions in the filter to determine the data to return.

Conditional update

Update data in a table only when the specified conditions are met. Otherwise, the update fails and an error is returned.

Atomic counter

The atomic counter feature allows you to specify a column as an atomic counter and perform atomic counter operations on the column.

Local transaction

After you enable local transaction for a data table, you can create a local transaction based on a partition key value.

ComputeSplitsBySize

You can split data in a table into logical shards whose sizes are approximately the specified value. The information about the split points among the shards and the machines on which the shards reside is returned.

Search index

Create a search index

You can create a search index for a data table.

List search indexes

Query search indexes that are created for a table.

Update search index configurations

Update the time to live (TTL) of a search index.

Query search index description

Query the description of a search index, including the information about the fields in the search index and configurations of the search index.

Delete a search index

Delete a specified search index.

Basic query

Basic query types include match all query, term query, terms query, prefix query, range query, wildcard query, exists query, collapse (deduplicate), geo query, and nested query.

Boolean query

Query conditions can contain one or more subconditions. Data is determined to meet the query conditions based on the subconditions.

Sorting and pagination

When you query data by using a search index, you can specify a sorting method to obtain the returned data. When many rows are returned, you can use offset-based pagination or token-based pagination to quickly locate the data you need.

Aggregation

You can implement operations such as finding minimum values, finding maximum values, summing, calculating averages, counting rows, counting distinct values, grouping by field values, grouping by range, grouping by geographical location, and grouping by filter conditions. Multiple aggregation features can be used together to meet complex query requirements.

Full-text index

Tablestore provides match query and phrase query to implement full-text index features. Data is matched based on tokenization during queries.

Concurrent data export

When you do not need to sort the entire result set, you can use the parallel scan feature to return all matched data at a faster rate.

Secondary index

Create a secondary index

Create a secondary index for a data table.

Read data from a secondary index

You can query data in a secondary index by reading a single row of data or reading data whose primary key values are within a specific range. If the required attribute columns are included in the secondary index, data can be directly read from the secondary index. Otherwise, data must be read from the data table.

Delete a secondary index

Delete a specified secondary index from a data table.

SQL query

Create a mapping table

Create a mapping table for an existing table or index.

Update attribute columns of a mapping table

Add or remove attribute columns in an existing mapping table.

Delete a mapping table

Delete one or more mapping tables

List table names

List the mapping tables in the current database.

Query table description

Query the description of a table, such as field names and field types.

Query index description

Query the index description of a table.

Query data

You can use the SELECT syntax to query data in a table.

Version compatibility

The latest version of Tablestore SDK for PHP is 5.x.x. The following items describe the compatibility between the latest version and earlier versions:

  • Tablestore SDK for PHP 4.x.x: compatible.

  • Tablestore SDK for PHP 2.x.x: incompatible.

For more information, see Version history of Tablestore SDK for PHP.

References

For information about how to troubleshoot Tablestore errors, see Error handling.