Alibaba Cloud Tablestore binding spec
Detailed documentation on the Alibaba Tablestore binding component
Component format
To setup an Alibaba Cloud Tablestore binding create a component of type bindings.alicloud.tablestore
. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: mytablestore
namespace: default
spec:
type: bindings.alicloud.tablestore
version: v1
metadata:
- name: endpoint
value: "[endpoint]"
- name: accessKeyID
value: "[key-id]"
- name: accessKey
value: "[access-key]"
- name: instanceName
value: "[instance]"
- name: tableName
value: "[table]"
- name: endpoint
value: "[endpoint]"
Warning
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.
Spec metadata fields
Field | Required | Binding support | Details | Example |
---|---|---|---|---|
endpoint | Y | Output | Alicloud Tablestore endpoint. | https://tablestore-cn-hangzhou.aliyuncs.com |
accessKeyID | Y | Output | Access key ID credential. | |
accessKey | Y | Output | Access key credential. | |
instanceName | Y | Output | Name of the instance. | |
tableName | Y | Output | Name of the table. |
Binding support
This component supports output binding with the following operations:
create
: Create object
Create object
To perform a create object operation, invoke the binding with a POST
method and the following JSON body:
{
"operation": "create",
"data": "YOUR_CONTENT",
"metadata": {
"primaryKeys": "pk1"
}
}
Note
Note the metadata.primaryKeys
field is mandatory.
Delete object
To perform a delete object operation, invoke the binding with a POST
method and the following JSON body:
{
"operation": "delete",
"metadata": {
"primaryKeys": "pk1",
"columnToGet": "name,age,date"
},
"data": {
"pk1": "data1"
}
}
Note
Note the metadata.primaryKeys
field is mandatory.
List objects
To perform a list objects operation, invoke the binding with a POST
method and the following JSON body:
{
"operation": "delete",
"metadata": {
"primaryKeys": "pk1",
"columnToGet": "name,age,date"
},
"data": {
"pk1": "data1",
"pk2": "data2"
}
}
Note
Note the metadata.primaryKeys
field is mandatory.
Get object
To perform a get object operation, invoke the binding with a POST
method and the following JSON body:
{
"operation": "delete",
"metadata": {
"primaryKeys": "pk1"
},
"data": {
"pk1": "data1"
}
}
Note
Note the metadata.primaryKeys
field is mandatory.
Related links
- Bindings building block
- How-To: Use bindings to interface with external resources
- Bindings API reference
Last modified November 12, 2021 : Merge pull request #1949 from willtsai/az-staticwebapp-versioning (c40e456)