Properties
| Name | Type | Description |
|---|---|---|
| shard_key | object | |
| shards_number | integer | How many shards to create for this key If not specified, will use the default value from config |
| replication_factor | integer | How many replicas to create for each shard If not specified, will use the default value from config |
| placement | array | Placement of shards for this key List of peer ids, that can be used to place shards for this key If not specified, will be randomly placed among all peers |
| initial_state | object | Initial state of the shards for this key If not specified, will be `Initializing` first and then `Active` Warning: do not change this unless you know what you are doing |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateShardingKey",
"title": "CreateShardingKey",
"type": "object",
"required": [
"shard_key"
],
"properties": {
"shard_key": {
"$ref": "#/components/schemas/ShardKey"
},
"shards_number": {
"description": "How many shards to create for this key If not specified, will use the default value from config",
"type": "integer",
"format": "uint32",
"minimum": 1,
"nullable": true
},
"replication_factor": {
"description": "How many replicas to create for each shard If not specified, will use the default value from config",
"type": "integer",
"format": "uint32",
"minimum": 1,
"nullable": true
},
"placement": {
"description": "Placement of shards for this key List of peer ids, that can be used to place shards for this key If not specified, will be randomly placed among all peers",
"type": "array",
"items": {
"type": "integer",
"format": "uint64",
"minimum": 0
},
"nullable": true
},
"initial_state": {
"description": "Initial state of the shards for this key If not specified, will be `Initializing` first and then `Active` Warning: do not change this unless you know what you are doing",
"anyOf": [
{
"$ref": "#/components/schemas/ReplicaState"
},
{
"nullable": true
}
]
}
}
}