Skip to content

Commit

Permalink
Miscellaneous admin API updates for 2.1; closes #772
Browse files Browse the repository at this point in the history
  • Loading branch information
Watts Martin committed Jul 9, 2015
1 parent 7195b9b commit f017f2e
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 16 deletions.
2 changes: 1 addition & 1 deletion api/javascript/administration/config.md
Expand Up @@ -20,7 +20,7 @@ database.config() → selection<object>

Query (read and/or update) the configurations for individual tables or databases.

The `config` command is a shorthand way to access the `table_config` or `db_config` [System tables](/docs/system-tables/). It will return the single row from the system that corresponds to the database or table configuration, as if [get](/api/javascript/get) had been called on the system table with the UUID of the database or table in question.
The `config` command is a shorthand way to access the `table_config` or `db_config` [System tables](/docs/system-tables/#configuration-tables). It will return the single row from the system that corresponds to the database or table configuration, as if [get](/api/javascript/get) had been called on the system table with the UUID of the database or table in question.

__Example:__ Get the configuration for the `users` table.

Expand Down
6 changes: 4 additions & 2 deletions api/javascript/administration/reconfigure.md
Expand Up @@ -12,8 +12,8 @@ io:
# Command syntax #

{% apibody %}
table.reconfigure({shards: <s>, replicas: <r>[, primaryReplicaTag: <t>, dryRun: false}]) &rarr; object
database.reconfigure({shards: <s>, replicas: <r>[, primaryReplicaTag: <t>, dryRun: false}]) &rarr; object
table.reconfigure({shards: <s>, replicas: <r>[, primaryReplicaTag: <t>, dryRun: false, nonvotingReplicaTags: null}]) &rarr; object
database.reconfigure({shards: <s>, replicas: <r>[, primaryReplicaTag: <t>, dryRun: false, nonvotingReplicaTags: null}]) &rarr; object
{% endapibody %}

# Description #
Expand All @@ -26,6 +26,8 @@ Reconfigure a table's sharding and replication.
* If `replicas` is an object, it specifies key-value pairs of server tags and the number of replicas to assign to those servers: `{tag1: 2, tag2: 4, tag3: 2, ...}`. For more information about server tags, read [Administration tools](/docs/administration-tools/).
* `primaryReplicaTag`: the primary server specified by its server tag. Required if `replicas` is an object; the tag must be in the object. This must *not* be specified if `replicas` is an integer.
* `dryRun`: if `true` the generated configuration will not be applied to the table, only returned.
* `nonvotingReplicaTags`: replicas with these server tags will be added to the `nonvoting_replicas` list of the resulting configuration. (See [failover](/docs/failover) for details about non-voting replicas.)

* `emergencyRepair`: Used for the Emergency Repair mode. See the separate section below.

The return value of `reconfigure` is an object with three fields:
Expand Down
2 changes: 1 addition & 1 deletion api/javascript/administration/status.md
Expand Up @@ -17,7 +17,7 @@ table.status() &rarr; selection&lt;object&gt;

Return the status of a table.

The return value is an object providing information about the table's shards, replicas and replica readiness states. For a more complete discussion of the object fields, read about the `table_status` table in [System tables](/docs/system-tables/).
The return value is an object providing information about the table's shards, replicas and replica readiness states. For a more complete discussion of the object fields, read about the `table_status` table in [System tables](/docs/system-tables/#status-tables).

* `id`: the UUID of the table.
* `name`: the table's name.
Expand Down
2 changes: 1 addition & 1 deletion api/python/administration/config.md
Expand Up @@ -15,7 +15,7 @@ database.config() &rarr; selection&lt;object&gt;

Query (read and/or update) the configurations for individual tables or databases.

The `config` command is a shorthand way to access the `table_config` or `db_config` [System tables](/docs/system-tables/). It will return the single row from the system that corresponds to the database or table configuration, as if [get](/api/python/get) had been called on the system table with the UUID of the database or table in question.
The `config` command is a shorthand way to access the `table_config` or `db_config` [System tables](/docs/system-tables/#configuration-tables). It will return the single row from the system that corresponds to the database or table configuration, as if [get](/api/python/get) had been called on the system table with the UUID of the database or table in question.

__Example:__ Get the configuration for the `users` table.

Expand Down
5 changes: 3 additions & 2 deletions api/python/administration/reconfigure.md
Expand Up @@ -7,8 +7,8 @@ command: reconfigure
# Command syntax #

{% apibody %}
table.reconfigure(shards=<s>, replicas=<r>[, primary_replica_tag=<t>, dry_run=False]) &rarr; object
database.reconfigure(shards=<s>, replicas=<r>[, primary_replica_tag=<t>, dry_run=False]) &rarr; object
table.reconfigure(shards=<s>, replicas=<r>[, primary_replica_tag=<t>, dry_run=False, nonvoting_replica_tags=None]) &rarr; object
database.reconfigure(shards=<s>, replicas=<r>[, primary_replica_tag=<t>, dry_run=False, nonvoting_replica_tags=None]) &rarr; object
{% endapibody %}

# Description #
Expand All @@ -21,6 +21,7 @@ Reconfigure a table's sharding and replication.
* If `replicas` is an object, it specifies key-value pairs of server tags and the number of replicas to assign to those servers: `{"tag1": 2, "tag2": 4, "tag3": 2, ...}`. For more information about server tags, read [Administration tools](/docs/administration-tools/).
* `primary_replica_tag`: the primary server specified by its server tag. Required if `replicas` is an object; the tag must be in the object. This must *not* be specified if `replicas` is an integer.
* `dry_run`: if `True` the generated configuration will not be applied to the table, only returned.
* `nonvoting_replica_tags`: replicas with these server tags will be added to the `nonvoting_replicas` list of the resulting configuration. (See [failover](/docs/failover) for details about non-voting replicas.)
* `emergency_repair`: Used for the Emergency Repair mode. See the separate section below.

The return value of `reconfigure` is an object with three fields:
Expand Down
2 changes: 1 addition & 1 deletion api/python/administration/status.md
Expand Up @@ -14,7 +14,7 @@ table.status() &rarr; selection&lt;object&gt;

Return the status of a table.

The return value is an object providing information about the table's shards, replicas and replica readiness states. For a more complete discussion of the object fields, read about the `table_status` table in [System tables](/docs/system-tables/).
The return value is an object providing information about the table's shards, replicas and replica readiness states. For a more complete discussion of the object fields, read about the `table_status` table in [System tables](/docs/system-tables/#status-tables).

* `id`: the UUID of the table.
* `name`: the table's name.
Expand Down
2 changes: 1 addition & 1 deletion api/ruby/administration/config.md
Expand Up @@ -15,7 +15,7 @@ database.config() &rarr; selection&lt;object&gt;

Query (read and/or update) the configurations for individual tables or databases.

The `config` command is a shorthand way to access the `table_config` or `db_config` [System tables](/docs/system-tables/). It will return the single row from the system that corresponds to the database or table configuration, as if [get](/api/ruby/get) had been called on the system table with the UUID of the database or table in question.
The `config` command is a shorthand way to access the `table_config` or `db_config` [System tables](/docs/system-tables/#configuration-tables). It will return the single row from the system that corresponds to the database or table configuration, as if [get](/api/ruby/get) had been called on the system table with the UUID of the database or table in question.

__Example:__ Get the configuration for the `users` table.

Expand Down
12 changes: 6 additions & 6 deletions api/ruby/administration/reconfigure.md
Expand Up @@ -62,12 +62,12 @@ r.table('superheroes').reconfigure({:shards => 2, :replicas => 1}).run(conn)
{
:primary_replica => "jeeves",
:replicas => ["jeeves"],
:nonvoting_replica_tags => []
:nonvoting_replicas => []
},
{
:primary_replica => "alfred",
:replicas => ["alfred"],
:nonvoting_replica_tags => []
:nonvoting_replicas => []
}
],
:write_acks => "majority",
Expand All @@ -82,7 +82,7 @@ r.table('superheroes').reconfigure({:shards => 2, :replicas => 1}).run(conn)
{
:primary_replica => "alfred",
:replicas => ["alfred"],
:nonvoting_replica_tags => []
:nonvoting_replicas => []
}
],
:write_acks => "majority",
Expand Down Expand Up @@ -117,12 +117,12 @@ r.table('superheroes').reconfigure({:shards => 2, :replicas => {:wooster => 1, :
{
:primary_replica => "jeeves",
:replicas => ["jeeves"],
:nonvoting_replica_tags => []
:nonvoting_replicas => []
},
{
:primary_replica => "alfred",
:replicas => ["alfred"],
:nonvoting_replica_tags => []
:nonvoting_replicas => []
}
],
:write_acks => "majority",
Expand All @@ -137,7 +137,7 @@ r.table('superheroes').reconfigure({:shards => 2, :replicas => {:wooster => 1, :
{
:primary_replica => "alfred",
:replicas => ["alfred"],
:nonvoting_replica_tags => []
:nonvoting_replicas => []
}
],
:write_acks => "majority",
Expand Down
2 changes: 1 addition & 1 deletion api/ruby/administration/status.md
Expand Up @@ -14,7 +14,7 @@ table.status() &rarr; selection&lt;object&gt;

Return the status of a table.

The return value is an object providing information about the table's shards, replicas and replica readiness states. For a more complete discussion of the object fields, read about the `table_status` table in [System tables](/docs/system-tables/).
The return value is an object providing information about the table's shards, replicas and replica readiness states. For a more complete discussion of the object fields, read about the `table_status` table in [System tables](/docs/system-tables/#status-tables).

* `id`: the UUID of the table.
* `name`: the table's name.
Expand Down

0 comments on commit f017f2e

Please sign in to comment.