OTSClient is a client for Tablestore. OTSClient provides various methods for you to manage tables and perform read and write operations on a single row or multiple rows. To use Tablestore SDK for .NET to initiate a request, you must initialize an OTSClient instance and modify the default configurations of the OTSClient instance based on your business requirements.
Usage notes
Tablestore SDK for .NET supports multithreading. We recommend that you use the same OTSClient instance among the multiple threads of a task.
Preparations
Before you initialize an OTSClient instance, you must configure an AccessKey pair, obtain the endpoint of your Tablestore instance, and install Tablestore SDK for .NET.
Configure an AccessKey pair
Obtain the endpoint of a Tablestore instance
Install Tablestore SDK for .NET
Initialize an OTSClient instance
To use Tablestore SDK for .NET, you must first create an OTSClient instance. Then, you can call the methods of the OTSClient instance to access Tablestore.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use the AccessKey pair of a RAM user to call API operations or perform routine O&M. We recommend that you do not hard-code the AccessKey ID and AccessKey secret into your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources in your account is compromised. In the following examples, the AccessKey pair is configured in the environment variables to verify your identify.
Syntax
/// <summary>
/// The function used to create an OTSClient instance.
/// </summary>
/// <param name="endPoint">The endpoint of the Tablestore instance, which must start with https://. Example: https://instance.cn-hangzhou.ots.aliyun.com:80 </param>
/// <param name="accessKeyID"> The AccessKey ID that is used to access the Tablestore instance. You can obtain an AccessKey ID on the Alibaba Cloud official website. </param>
/// <param name="accessKeySecret"> The AccessKey secret that is used to access the Tablestore instance. You can obtain an AccessKey secret on the Alibaba Cloud official website. </param>
/// <param name="instanceName"> The name of the Tablestore instance. You can customize the instance name in the Tablestore console. </param>
public OTSClient(string endPoint, string accessKeyID, string accessKeySecret, string instanceName);
/// <summary>
/// Create an OTSClient instance by configuring the instance of the OTSClientConfig class on the client.
/// </summary>
/// <param name="config">The instance for client configurations.</param>
public OTSClient(OTSClientConfig config);
Example
Use the endpoint of a Tablestore instance to create a client.
// Create an OTSClientConfig object. public static string AccessKeyId = Environment.GetEnvironmentVariable("OTS_AK_ENV"); public static string AccessKeySecret = Environment.GetEnvironmentVariable("OTS_SK_ENV"); var config = new OTSClientConfig(Endpoint, AccessKeyId, AccessKeySecret, InstanceName); // Disable logging. By default, logging is enabled. config.OTSDebugLogHandler = null; config.OTSErrorLogHandler = null; // Create an OTSClient object by using OTSClientConfig. var otsClient = new OTSClient(config);
The following table describes the parameters.
Parameter
Example
Description
Endpoint
https://myinstance.cn-hangzhou.ots.aliyuncs.com
The endpoint that is used to access the Tablestore instance. For more information about how to obtain the endpoint, see the Obtain the endpoint of a Tablestore instance section of this topic.
AccessKeyId
Environment.GetEnvironmentVariable("OTS_AK_ENV")
The AccessKey pair that is used to access the Tablestore instance. Obtain the AccessKey pair by using environment variables.
Make sure that the environment variables are configured. For more information, see the Configure an AccessKey pair section of this topic.
AccessKeySecret
Environment.GetEnvironmentVariable("OTS_SK_ENV")
InstanceName
myinstance
The name of the Tablestore instance that you want to access. For more information, see Instance.
Configure the OTSClient instance.
To modify the default configurations of the OTSClient instance, import the required parameters when you create the OTSClient instance, such as those that specify the maximum number of connections and retry policy. The following table describes the parameters that you can configure when you create the OTSClient instance.
Parameter
Description
ConnectionLimit
The maximum number of connections allowed to the Tablestore instance. Default value: 300.
OTSDebugLogHandler
The function to process debug logs, which is used to display the logs of normal requests and responses. Default value: defaultOTSDebugLogHandler.
To disable the function, set this parameter to null.
OTSErrorLogHandler
The function to process error logs, which is used to display the logs of errors returned by Tablestore. Default value: defaultOTSErrorLogHandler.
To disable the function, set this parameter to null.
RetryPolicy
The retry policy. Default value: DefaultRetryPolicy. You can also customize the retry policy.
To disable the retry policy, set this parameter to null.
FAQ
What do I do if the Signature mismatch error is reported when I use Tablestore SDKs?