model

package
v0.1.123 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2024 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchWriteKvRequest 

type BatchWriteKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *BatchWriteKvRequestBody `bson:"body,omitempty"`
}

BatchWriteKvRequest Request Object

func (BatchWriteKvRequest) String 

func (o BatchWriteKvRequest) String() string

type BatchWriteKvRequestBody 

type BatchWriteKvRequestBody struct {

	// 行操作数组，可以是多个表的操作。
	TableOpers []TableBatch `bson:"table_opers"`
}

func (BatchWriteKvRequestBody) String 

func (o BatchWriteKvRequestBody) String() string

type BatchWriteKvResponse 

type BatchWriteKvResponse struct {

	// 未处理的操作列表。
	UnprocessedOpers *[]TableOperIds `bson:"unprocessed_opers,omitempty"`
	HttpStatusCode   int             `bson:"-"`
}

BatchWriteKvResponse Response Object

func (BatchWriteKvResponse) String 

func (o BatchWriteKvResponse) String() string

type CheckHealthRequest added in v0.1.121 

type CheckHealthRequest struct {
	Body *CheckHealthRequestBody `bson:"body,omitempty"`
}

CheckHealthRequest Request Object

func (CheckHealthRequest) String added in v0.1.121 

func (o CheckHealthRequest) String() string

type CheckHealthRequestBody added in v0.1.121 

type CheckHealthRequestBody struct {

	// version
	Version *int32 `bson:"version,omitempty"`
}

func (CheckHealthRequestBody) String added in v0.1.121 

func (o CheckHealthRequestBody) String() string

type CheckHealthResponse added in v0.1.121 

type CheckHealthResponse struct {
	HttpStatusCode int `bson:"-"`
}

CheckHealthResponse Response Object

func (CheckHealthResponse) String added in v0.1.121 

func (o CheckHealthResponse) String() string

type ComposedExpression 

type ComposedExpression struct {

	// 逻辑关系，取值如\"$and\", \"$or\", \"$nor\"。
	Logic *string `bson:"logic,omitempty"`

	// 多个相同优先级且相同逻辑的单字段或多字段条件。
	Expressions []Expression `bson:"expressions"`
}

func (ComposedExpression) String 

func (o ComposedExpression) String() string

type ConditionExpression 

type ConditionExpression struct {
	SingleFieldExpression *SingleFieldExpression `bson:"single_field_expression,omitempty"`

	MultiFieldExpression *MultiFieldExpression `bson:"multi_field_expression,omitempty"`

	ComposedExpression *ComposedExpression `bson:"composed_expression,omitempty"`
}

func (ConditionExpression) String 

func (o ConditionExpression) String() string

type CreateTableRequest 

type CreateTableRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *CreateTableRequestBody `bson:"body,omitempty"`
}

CreateTableRequest Request Object

func (CreateTableRequest) String 

func (o CreateTableRequest) String() string

type CreateTableRequestBody 

type CreateTableRequestBody struct {

	// 表名，仓内唯一。
	TableName string `bson:"table_name"`

	// 表计费模式，可为\"provisioned\"或\"on_demand\" - 预置模式：provisioned - 按需模式：on_demand
	BillMode *string `bson:"bill_mode,omitempty"`

	ProvisionedThroughput *ProvisionedThroughput `bson:"provisioned_throughput,omitempty"`

	PrimaryKeySchema *PrimaryKeySchema `bson:"primary_key_schema"`

	// 本地二级索引模板，可以多个。
	LocalSecondaryIndexSchema *[]SecondaryIndex `bson:"local_secondary_index_schema,omitempty"`

	// 全局二级索引模板。
	GlobalSecondaryIndexSchema *[]GlobalSecondaryIndex `bson:"global_secondary_index_schema,omitempty"`

	PreSplitKeyOptions *PreSplitKeyOptions `bson:"pre_split_key_options,omitempty"`

	TtlOptions *TtlOptions `bson:"ttl_options,omitempty"`
}

func (CreateTableRequestBody) String 

func (o CreateTableRequestBody) String() string

type CreateTableResponse 

type CreateTableResponse struct {

	// 表名，仓内唯一。
	TableName *string `bson:"table_name,omitempty"`

	// 计费模式，可为\"provisioned\"或\"on_demand\"
	BillMode *string `bson:"bill_mode,omitempty"`

	ProvisionedThroughput *ProvisionedThroughput `bson:"provisioned_throughput,omitempty"`

	PrimaryKeySchema *PrimaryKeySchema `bson:"primary_key_schema,omitempty"`

	// 本地二级索引模板，可以多个。
	LocalSecondaryIndexSchema *[]SecondaryIndex `bson:"local_secondary_index_schema,omitempty"`

	// 全局二级索引模板。
	GlobalSecondaryIndexSchema *[]GlobalSecondaryIndex `bson:"global_secondary_index_schema,omitempty"`

	PreSplitKeyOptions *PreSplitKeyOptions `bson:"pre_split_key_options,omitempty"`
	HttpStatusCode     int                 `bson:"-"`
}

CreateTableResponse Response Object

func (CreateTableResponse) String 

func (o CreateTableResponse) String() string

type DeleteKv 

type DeleteKv struct {

	// 请求内的操作编码，未成功的操作返回该标识。
	OperId int32 `bson:"oper_id"`

	// 用户自定义的主键名及值。
	PrimaryKey *bson.D `bson:"primary_key"`
}

func (DeleteKv) String 

func (o DeleteKv) String() string

type DeleteKvRequest 

type DeleteKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *DeleteKvRequestBody `bson:"body,omitempty"`
}

DeleteKvRequest Request Object

func (DeleteKvRequest) String 

func (o DeleteKvRequest) String() string

type DeleteKvRequestBody 

type DeleteKvRequestBody struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	// 用户自定义的主键名及值。 > 内容字段为主键字段名和值，组合索引多个元素。
	PrimaryKey *bson.D `bson:"primary_key"`

	ConditionExpression *ConditionExpression `bson:"condition_expression,omitempty"`
}

func (DeleteKvRequestBody) String 

func (o DeleteKvRequestBody) String() string

type DeleteKvResponse 

type DeleteKvResponse struct {
	HttpStatusCode int `bson:"-"`
}

DeleteKvResponse Response Object

func (DeleteKvResponse) String 

func (o DeleteKvResponse) String() string

type DescribeTableRequest 

type DescribeTableRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *DescribeTableRequestBody `bson:"body,omitempty"`
}

DescribeTableRequest Request Object

func (DescribeTableRequest) String 

func (o DescribeTableRequest) String() string

type DescribeTableRequestBody 

type DescribeTableRequestBody struct {

	// 表名。 - 长度：[3, 63] - 取值字符限制：[a-zA-Z0-9_-]+
	TableName string `bson:"table_name"`
}

func (DescribeTableRequestBody) String 

func (o DescribeTableRequestBody) String() string

type DescribeTableResponse 

type DescribeTableResponse struct {

	// 表名。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName *string `bson:"table_name,omitempty"`

	PrimaryKeySchema *PrimaryKeySchema `bson:"primary_key_schema,omitempty"`

	// 本地二级索引模板，可以多个。
	LocalSecondaryIndexSchema *[]SecondaryIndex `bson:"local_secondary_index_schema,omitempty"`

	// 全局二级索引模板。
	GlobalSecondaryIndexSchema *[]GlobalSecondaryIndex `bson:"global_secondary_index_schema,omitempty"`

	RunTimeInfo *RunTimeInfo `bson:"run_time_info,omitempty"`

	TtlOptions     *TtlOptions `bson:"ttl_options,omitempty"`
	HttpStatusCode int         `bson:"-"`
}

DescribeTableResponse Response Object

func (DescribeTableResponse) String 

func (o DescribeTableResponse) String() string

type Expression 

type Expression struct {
	SingleFieldExpression *SingleFieldExpression `bson:"single_field_expression,omitempty"`

	MultiFieldExpression *MultiFieldExpression `bson:"multi_field_expression,omitempty"`

	ComposedExpression *ComposedExpression `bson:"composed_expression,omitempty"`
}

func (Expression) String 

func (o Expression) String() string

type Field 

type Field struct {

	// 字段名。
	Name string `bson:"name"`

	// bool值预留无意义。
	Order *bool `bson:"order,omitempty"`
}

func (Field) String 

func (o Field) String() string

type GetKvRequest 

type GetKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *GetKvRequestBody `bson:"body,omitempty"`
}

GetKvRequest Request Object

func (GetKvRequest) String 

func (o GetKvRequest) String() string

type GetKvRequestBody 

type GetKvRequestBody struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	// 用户自定义的主键名及值。
	PrimaryKey *bson.D `bson:"primary_key"`
}

func (GetKvRequestBody) String 

func (o GetKvRequestBody) String() string

type GetKvResponse 

type GetKvResponse struct {

	// 对kv_doc有效。 > 内容字段：主键字段+投影字段或者全部字段。
	KvDoc          *bson.D `bson:"kv_doc,omitempty"`
	HttpStatusCode int     `bson:"-"`
}

GetKvResponse Response Object

func (GetKvResponse) String 

func (o GetKvResponse) String() string

type GlobalSecondaryIndex 

type GlobalSecondaryIndex struct {

	// 二级索引名称，表内唯一。
	IndexName string `bson:"index_name"`

	// 分区键字段名数组，顺序组合。
	ShardKeyFields []Field `bson:"shard_key_fields"`

	// 分区模式。
	ShardMode *string `bson:"shard_mode,omitempty"`

	// 排序键字段名数组，顺序组合。
	SortKeyFields *[]Field `bson:"sort_key_fields,omitempty"`

	// 摘要字段名数组。
	AbstractFields *[]string `bson:"abstract_fields,omitempty"`

	ProvisionedThroughput *ProvisionedThroughput `bson:"provisioned_throughput,omitempty"`
}

func (GlobalSecondaryIndex) String 

func (o GlobalSecondaryIndex) String() string

type GlobalSecondaryIndexInfo 

type GlobalSecondaryIndexInfo struct {

	// 二级索引名称。
	IndexName string `bson:"index_name"`

	// 二级索引名称。 - \"creating\" - \"active\" - \"deleting\"
	IndexStatus string `bson:"index_status"`
}

func (GlobalSecondaryIndexInfo) String 

func (o GlobalSecondaryIndexInfo) String() string

type KvOperIds 

type KvOperIds struct {

	// 上传kv操作, \"oper_id\"数组。 - 数组元素：请求内的操作编码，未成功的操作返回该标识。
	PutKvIds *[]int32 `bson:"put_kv_ids,omitempty"`

	// 请求内的操作编码，未成功的操作返回该标识。 - 数组元素：请求内的操作编码，未成功的操作返回该标识。
	DeleteKvIds *[]int32 `bson:"delete_kv_ids,omitempty"`
}

func (KvOperIds) String 

func (o KvOperIds) String() string

type ListStoreRequest 

type ListStoreRequest struct {
	Body *ListStoreRequestBody `bson:"body,omitempty"`
}

ListStoreRequest Request Object

func (ListStoreRequest) String 

func (o ListStoreRequest) String() string

type ListStoreRequestBody 

type ListStoreRequestBody struct {

	// 上次返回的游标位置，本次响应包含该仓名。 - 长度：[16,52] - 取值字符限制：[a-z0-9-]+
	CursorName *string `bson:"cursor_name,omitempty"`

	// 响应返回的仓个数。
	Limit *int32 `bson:"limit,omitempty"`
}

func (ListStoreRequestBody) String 

func (o ListStoreRequestBody) String() string

type ListStoreResponse 

type ListStoreResponse struct {

	// 本次响应后的游标位置，下次请求时携带。 - 长度：[16,52] - 取值字符限制：[a-z0-9-]+ > 如果为空，表示后面无更多仓名。
	CursorName *string `bson:"cursor_name,omitempty"`

	// 返回的仓名列表。
	Stores         *[]string `bson:"stores,omitempty"`
	HttpStatusCode int       `bson:"-"`
}

ListStoreResponse Response Object

func (ListStoreResponse) String 

func (o ListStoreResponse) String() string

type ListTableRequest 

type ListTableRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *ListTableRequestBody `bson:"body,omitempty"`
}

ListTableRequest Request Object

func (ListTableRequest) String 

func (o ListTableRequest) String() string

type ListTableRequestBody 

type ListTableRequestBody struct {

	// 上次返回游标位置，本次响应包含该table，空表示遍历完。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+ > 如果为空，表示后面无更多。
	CursorName *string `bson:"cursor_name,omitempty"`

	// 响应返回的表个数。 - 长度：最大100
	Limit *int32 `bson:"limit,omitempty"`
}

func (ListTableRequestBody) String 

func (o ListTableRequestBody) String() string

type ListTableResponse 

type ListTableResponse struct {

	// 本次响应后的游标位置，下次请求时携带，如果为空，表示后面无更多。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+ > 如果为空，表示后面无更多。
	CursorName *string `bson:"cursor_name,omitempty"`

	// 返回的表名列表。 - 长度：最大100
	TableNames     *[]string `bson:"table_names,omitempty"`
	HttpStatusCode int       `bson:"-"`
}

ListTableResponse Response Object

func (ListTableResponse) String 

func (o ListTableResponse) String() string

type MultiFieldExpression 

type MultiFieldExpression struct {

	// 多字段条件，多个相同优先级的单字段条件。
	Logic *string `bson:"logic,omitempty"`

	// 多个相同逻辑操作的单字段条件。
	Expressions []SingleFieldExpression `bson:"expressions"`
}

func (MultiFieldExpression) String 

func (o MultiFieldExpression) String() string

type OperItem 

type OperItem struct {
	PutKv *PutKv `bson:"put_kv,omitempty"`

	DeleteKv *DeleteKv `bson:"delete_kv,omitempty"`
}

OperItem put_kv或delete_kv或get_kv操作。

func (OperItem) String 

func (o OperItem) String() string

type PreSplitKeyOptions 

type PreSplitKeyOptions struct {

	// 在range分区模式有效，最大10个。
	RangeSplitPoints *[]bson.D `bson:"range_split_points,omitempty"`
}

PreSplitKeyOptions 按照设定的键值前缀进行预分裂。

func (PreSplitKeyOptions) String 

func (o PreSplitKeyOptions) String() string

type PrimaryKeySchema 

type PrimaryKeySchema struct {

	// 分区键字段名数组，顺序组合。
	ShardKeyFields []Field `bson:"shard_key_fields"`

	// 分区模式。
	ShardMode *string `bson:"shard_mode,omitempty"`

	// 排序键字段名数组，顺序组合。
	SortKeyFields *[]Field `bson:"sort_key_fields,omitempty"`
}

func (PrimaryKeySchema) String 

func (o PrimaryKeySchema) String() string

type ProvisionedThroughput added in v0.1.117 

type ProvisionedThroughput struct {

	// 预置表级读请求单元数
	Rcu int64 `bson:"rcu"`

	// 预置表级写请求单元数
	Wcu int64 `bson:"wcu"`
}

func (ProvisionedThroughput) String added in v0.1.117 

func (o ProvisionedThroughput) String() string

type PutKv 

type PutKv struct {

	// 请求内的操作编码，未成功的操作返回该标识。
	OperId int32 `bson:"oper_id"`

	// 用户文档。
	KvDoc *bson.D `bson:"kv_doc,omitempty"`
}

func (PutKv) String 

func (o PutKv) String() string

type PutKvRequest 

type PutKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *PutKvRequestBody `bson:"body,omitempty"`
}

PutKvRequest Request Object

func (PutKvRequest) String 

func (o PutKvRequest) String() string

type PutKvRequestBody 

type PutKvRequestBody struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	ConditionExpression *ConditionExpression `bson:"condition_expression,omitempty"`

	// 用户文档。
	KvDoc *bson.D `bson:"kv_doc,omitempty"`
}

func (PutKvRequestBody) String 

func (o PutKvRequestBody) String() string

type PutKvResponse 

type PutKvResponse struct {
	HttpStatusCode int `bson:"-"`
}

PutKvResponse Response Object

func (PutKvResponse) String 

func (o PutKvResponse) String() string

type ReturnedKvItem 

type ReturnedKvItem struct {

	// 对kv_doc有效。
	KvDoc *bson.D `bson:"kv_doc,omitempty"`
}

ReturnedKvItem kv元素。

func (ReturnedKvItem) String 

func (o ReturnedKvItem) String() string

type ReturnedSegmentItem 

type ReturnedSegmentItem struct {

	// 采样段区间起始值。
	SegmentMinKey *bson.D `bson:"segment_min_key,omitempty"`

	// 采样段区间终止值。
	SegmentMaxKey *bson.D `bson:"segment_max_key,omitempty"`
}

ReturnedSegmentItem 采样段的起始终止主键对。

func (ReturnedSegmentItem) String 

func (o ReturnedSegmentItem) String() string

type RunTimeInfo 

type RunTimeInfo struct {
	TableInfo *TableInfo `bson:"table_info"`

	// 索引状态。
	LocalSecondaryIndexInfos *[]SecondaryIndexInfo `bson:"local_secondary_index_infos,omitempty"`

	// 全局二级索引运行态。
	GlobalSecondaryIndexInfos *[]GlobalSecondaryIndexInfo `bson:"global_secondary_index_infos,omitempty"`
}

func (RunTimeInfo) String 

func (o RunTimeInfo) String() string

type ScanKvRequest 

type ScanKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *ScanKvRequestBody `bson:"body,omitempty"`
}

ScanKvRequest Request Object

func (ScanKvRequest) String 

func (o ScanKvRequest) String() string

type ScanKvRequestBody 

type ScanKvRequestBody struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	// create_table时指定的索引名，默认空表示主索引。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	HintIndexName *string `bson:"hint_index_name,omitempty"`

	// 数据量不超过1MB时，返回的文档个数，最大100个，默认1MB或者100个文档。
	Limit *int32 `bson:"limit,omitempty"`

	// 起始主键或索引键值。 - 默认空，表示从头遍历，左闭。 > 分页返回时，该值使用上次响应返回的cursor_key。
	StartKey *bson.D `bson:"start_key,omitempty"`

	// 终止主键或索引键值。 - 默认空，表示直到最后，右开。
	EndKey *bson.D `bson:"end_key,omitempty"`

	FilterExpression *ConditionExpression `bson:"filter_expression,omitempty"`

	// 对表进行采样，尽最大努力保证返回的段列表均分整张表。举例：sample_segments_count=4，返回的段列表[MinKey, KV1)、[KV1,KV2)、[KV2,KV3)和[KV3,MaxKey)。用户可以使用scan-kv对这四个分区执行并发扫描，提高遍历效率。 - 范围: [1, 10000]。默认值：不执行采样。 - sample_segments_count仅能和table_name、start_key和end_key字段配合使用。Range分区模式下支持全表采样和范围采样；Hash分区模式仅支持全表扫描。 - 仅支持对Primary key进行采样，不支持本地/全局二级索引。 - 返回的段列表仅包含主键，不包含键值；且段列表是编码后的数据 ，不可修改。
	SampleSegmentsCount *int32 `bson:"sample_segments_count,omitempty"`

	// 返回查询条件对应的KV总数. - 当KV总数小于limit条件时，返回KV查询结果和KV总数。 - 当KV总数多于limit条件时，只返回KV总数。
	ReturnCountOnly *bool `bson:"return_count_only,omitempty"`
}

func (ScanKvRequestBody) String 

func (o ScanKvRequestBody) String() string

type ScanKvResponse 

type ScanKvResponse struct {

	// 返回的文档数量，为0不表示结束。 > 如果filtered_count超过500仍无匹配，则返回0。
	ReturnedCount *int64 `bson:"returned_count,omitempty"`

	// 被过滤掉的文档数量。
	FilteredCount *int32 `bson:"filtered_count,omitempty"`

	// 下次请求时的start_key，该值为空时，表示指定范围或者指定filter条件所有kv已经返回。
	CursorKey *bson.D `bson:"cursor_key,omitempty"`

	// 返回的kv数据。
	ReturnedKvItems *[]ReturnedKvItem `bson:"returned_kv_items,omitempty"`

	// 采样段区间列表。
	ReturnedSegmentItems *[]ReturnedSegmentItem `bson:"returned_segment_items,omitempty"`
	HttpStatusCode       int                    `bson:"-"`
}

ScanKvResponse Response Object

func (ScanKvResponse) String 

func (o ScanKvResponse) String() string

type ScanSkeyKvRequest 

type ScanSkeyKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *ScanSkeyKvRequestBody `bson:"body,omitempty"`
}

ScanSkeyKvRequest Request Object

func (ScanSkeyKvRequest) String 

func (o ScanSkeyKvRequest) String() string

type ScanSkeyKvRequestBody 

type ScanSkeyKvRequestBody struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	// create_table时指定的索引名。
	HintIndexName *string `bson:"hint_index_name,omitempty"`

	// 数据量不超过1MB时，返回的文档个数，最大100个，默认1MB或者100个文档。
	Limit *int32 `bson:"limit,omitempty"`

	// 要遍历的指定分区键下的kv。
	ShardKey *bson.D `bson:"shard_key"`

	// 起始排序键值，默认空表示从头遍历，左闭。 > 分页返回时，该值使用上次响应返回的cursor_sort_key
	StartSortKey *bson.D `bson:"start_sort_key,omitempty"`

	// 终止主键或索引键值，默认空表示直到最后，右开。
	EndSortKey *bson.D `bson:"end_sort_key,omitempty"`

	FilterExpression *ConditionExpression `bson:"filter_expression,omitempty"`

	// 返回查询条件对应的KV总数. - 当KV总数小于limit条件时，返回KV查询结果和KV总数。 - 当KV总数多于limit条件时，只返回KV总数。
	ReturnCountOnly *bool `bson:"return_count_only,omitempty"`
}

func (ScanSkeyKvRequestBody) String 

func (o ScanSkeyKvRequestBody) String() string

type ScanSkeyKvResponse 

type ScanSkeyKvResponse struct {

	// 返回的文档数量，为0不表示结束。 - 如果filtered_count超过500仍无匹配，则返回0。 -  长度：4
	ReturnedCount *int64 `bson:"returned_count,omitempty"`

	// 被过滤掉的文档数量。 - 长度：4
	FilteredCount *int32 `bson:"filtered_count,omitempty"`

	// 下次请求时的start_key。 > 该值为空时，表示指定范围或者指定filter条件所有kv已经返回。
	CursorSortKey *bson.D `bson:"cursor_sort_key,omitempty"`

	// 返回的kv列表，与scan_kv的kv_array相同。
	ReturnedKvItems *[]ReturnedKvItem `bson:"returned_kv_items,omitempty"`
	HttpStatusCode  int               `bson:"-"`
}

ScanSkeyKvResponse Response Object

func (ScanSkeyKvResponse) String 

func (o ScanSkeyKvResponse) String() string

type SecondaryIndex 

type SecondaryIndex struct {

	// 二级索引名称，表内唯一。
	IndexName string `bson:"index_name"`

	// 排序键字段名数组，顺序组合。
	SortKeyFields []Field `bson:"sort_key_fields"`

	// 摘要字段名数组。
	AbstractFields *[]string `bson:"abstract_fields,omitempty"`
}

SecondaryIndex 二级索引定义，元素key为数组下标。

func (SecondaryIndex) String 

func (o SecondaryIndex) String() string

type SecondaryIndexInfo 

type SecondaryIndexInfo struct {

	// 索引状态。 - 长度：[1, 255] - 取值字符限制：[a-z0-9_-]+
	IndexName string `bson:"index_name"`

	// 索引状态。 - \"creating\" - \"active\" - \"deleting\"
	IndexStatus string `bson:"index_status"`
}

func (SecondaryIndexInfo) String 

func (o SecondaryIndexInfo) String() string

type SingleFieldExpression 

type SingleFieldExpression struct {

	// 条件字段。
	Field string `bson:"field"`

	// 条件函数，取值如\"$gt\", $lt\",\"$gte\", $lte\" \"$eq\", \"$ne\", \"$prefix\", \"$exists\"。
	Func string `bson:"func"`

	// value和value_array二选一。 - value条件值，适用于除\"$in\", \"$nin\"外的func。 - 字段名无意义，可以传空，也可以传字段名。 - $exists值为true/false。 > $prefix操作只适用于string和binary类型。
	Value *bson.D `bson:"value,omitempty"`

	// \"value\"和\"value_array\"二选一。 - \"value_array\" 条件值列表, 值用于\"$in\", \"$nin\"。
	ValueArray *[]bson.D `bson:"value_array,omitempty"`
}

func (SingleFieldExpression) String 

func (o SingleFieldExpression) String() string

type TableBatch 

type TableBatch struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	// kv操作数组。
	KvOpers []OperItem `bson:"kv_opers"`
}

TableBatch 单个表的所有kv操作。

func (TableBatch) String 

func (o TableBatch) String() string

type TableInfo 

type TableInfo struct {

	// 表状态。 - \"creating\" - \"active\" - \"deleting\"
	TableStatus *string `bson:"table_status,omitempty"`
}

func (TableInfo) String 

func (o TableInfo) String() string

type TableOperIds 

type TableOperIds struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	KvOperIds *KvOperIds `bson:"kv_oper_ids"`
}

TableOperIds 某个表的行操作数组， 可以是多个文档的put_kv或delete_kv。

func (TableOperIds) String 

func (o TableOperIds) String() string

type TtlOptions added in v0.1.121 

type TtlOptions struct {

	// TTL开关
	TtlSwitch bool `bson:"ttl_switch"`

	// 生存时间，以秒为单位
	ExpireAfterSeconds *int32 `bson:"expire_after_seconds,omitempty"`

	// 文档中记录TTL过期时间的字段名，字段值为UTC时间，单位秒
	TtlFieldName *string `bson:"ttl_field_name,omitempty"`
}

func (TtlOptions) String added in v0.1.121 

func (o TtlOptions) String() string

type UpdateFields 

type UpdateFields struct {

	// 新增或覆盖更新1个或多个字段的值。 > 禁止修改sortkey的字段。
	Set *bson.D `bson:"set,omitempty"`

	// 对1个或多个字段做加法运算，并更新为运算后的值。
	Add *bson.D `bson:"add,omitempty"`

	// 删除1个或多个字段。 - 数组元素为待删除字段名。
	Rmv *[]string `bson:"rmv,omitempty"`

	// 插入元素到数组中 > 非数组返回失败。
	Insert *bson.D `bson:"insert,omitempty"`
}

func (UpdateFields) String 

func (o UpdateFields) String() string

type UpdateKvRequest 

type UpdateKvRequest struct {

	// 仓名，全域唯一，不同租户的仓名不能相同。  - 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id - 取值字符限制：[a-z0-9-]+ - 长度：[16,52] > \"-\"不能出现在名字头部或尾部
	StoreName *string `bson:"store_name,omitempty"`

	Body *UpdateKvRequestBody `bson:"body,omitempty"`
}

UpdateKvRequest Request Object

func (UpdateKvRequest) String 

func (o UpdateKvRequest) String() string

type UpdateKvRequestBody 

type UpdateKvRequestBody struct {

	// 表名，仓内唯一。 - 长度：[3, 63] - 取值字符限制：[a-z0-9_-]+
	TableName string `bson:"table_name"`

	// 用户自定义的主键名及值。 > 内容字段：主键字段名和值，组合索引多个元素。
	PrimaryKey *bson.D `bson:"primary_key"`

	ConditionExpression *ConditionExpression `bson:"condition_expression,omitempty"`

	UpdateFields *UpdateFields `bson:"update_fields,omitempty"`
}

func (UpdateKvRequestBody) String 

func (o UpdateKvRequestBody) String() string

type UpdateKvResponse 

type UpdateKvResponse struct {
	HttpStatusCode int `bson:"-"`
}

UpdateKvResponse Response Object

func (UpdateKvResponse) String 

func (o UpdateKvResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.