diff --git a/docs/deployments/configuration.md b/docs/deployments/configuration.md index f7fd1a11..210c38b5 100644 --- a/docs/deployments/configuration.md +++ b/docs/deployments/configuration.md @@ -458,13 +458,24 @@ The URL of the current Harper instance. `databases` - _Type_: string/array; _Default_: "\*" (all databases) -Configure which databases to replicate. This can be a string for all database or an array for specific databases. +Configure which databases to replicate. This can be a string for all database or an array for specific databases. The list can be a simple array of database names: ```yaml replication: databases: - - db1 - - db2 + - system + - data + - mydb +``` + +The database list can also specify databases that are purely "sharded" databases. For databases that are marked as sharded, replication will _only_ create database subscription connections to nodes in the same shard. Sharding can still function without this setting, since the residency location for sharding can be determined for each table or each record. However, using this setting will reduce the overhead of connections in situations where all data is uniformly sharded, creating a simpler and more efficient replication topology. To mark databases as sharded, you can specify a list of databases with a `name` and `sharded` flag: + +```yaml +replication: + databases: + - name: system + - name: data + sharded: true ``` `routes` - _Type_: array; diff --git a/versioned_docs/version-4.5/deployments/configuration.md b/versioned_docs/version-4.5/deployments/configuration.md index f5604760..f7f5f5a7 100644 --- a/versioned_docs/version-4.5/deployments/configuration.md +++ b/versioned_docs/version-4.5/deployments/configuration.md @@ -230,13 +230,24 @@ The URL of the current Harper instance. `databases` - _Type_: string/array; _Default_: "\*" (all databases) -Configure which databases to replicate. This can be a string for all database or an array for specific databases. +Configure which databases to replicate. This can be a string for all database or an array for specific databases. The list can be a simple array of database names: ```yaml replication: databases: - - db1 - - db2 + - system + - data + - mydb +``` + +The database list can also specify databases that are purely "sharded" databases. For databases that are marked as sharded, replication will _only_ create database subscription connections to nodes in the same shard. Sharding can still function without this setting, since the residency location for sharding can be determined for each table or each record. However, using this setting will reduce the overhead of connections in situations where all data is uniformly sharded, creating a simpler and more efficient replication topology. To mark databases as sharded, you can specify a list of databases with a `name` and `sharded` flag: + +```yaml +replication: + databases: + - name: system + - name: data + sharded: true ``` `routes` - _Type_: array; diff --git a/versioned_docs/version-4.6/deployments/configuration.md b/versioned_docs/version-4.6/deployments/configuration.md index 465a68dc..6965cdd8 100644 --- a/versioned_docs/version-4.6/deployments/configuration.md +++ b/versioned_docs/version-4.6/deployments/configuration.md @@ -230,13 +230,24 @@ The URL of the current Harper instance. `databases` - _Type_: string/array; _Default_: "\*" (all databases) -Configure which databases to replicate. This can be a string for all database or an array for specific databases. +Configure which databases to replicate. This can be a string for all database or an array for specific databases. The list can be a simple array of database names: ```yaml replication: databases: - - db1 - - db2 + - system + - data + - mydb +``` + +The database list can also specify databases that are purely "sharded" databases. For databases that are marked as sharded, replication will _only_ create database subscription connections to nodes in the same shard. Sharding can still function without this setting, since the residency location for sharding can be determined for each table or each record. However, using this setting will reduce the overhead of connections in situations where all data is uniformly sharded, creating a simpler and more efficient replication topology. To mark databases as sharded, you can specify a list of databases with a `name` and `sharded` flag: + +```yaml +replication: + databases: + - name: system + - name: data + sharded: true ``` `routes` - _Type_: array; diff --git a/versioned_docs/version-4.7/deployments/configuration.md b/versioned_docs/version-4.7/deployments/configuration.md index 57c98a3a..9de7a8a2 100644 --- a/versioned_docs/version-4.7/deployments/configuration.md +++ b/versioned_docs/version-4.7/deployments/configuration.md @@ -303,13 +303,24 @@ The URL of the current Harper instance. `databases` - _Type_: string/array; _Default_: "\*" (all databases) -Configure which databases to replicate. This can be a string for all database or an array for specific databases. +Configure which databases to replicate. This can be a string for all database or an array for specific databases. The list can be a simple array of database names: ```yaml replication: databases: - - db1 - - db2 + - system + - data + - mydb +``` + +The database list can also specify databases that are purely "sharded" databases. For databases that are marked as sharded, replication will _only_ create database subscription connections to nodes in the same shard. Sharding can still function without this setting, since the residency location for sharding can be determined for each table or each record. However, using this setting will reduce the overhead of connections in situations where all data is uniformly sharded, creating a simpler and more efficient replication topology. To mark databases as sharded, you can specify a list of databases with a `name` and `sharded` flag: + +```yaml +replication: + databases: + - name: system + - name: data + sharded: true ``` `routes` - _Type_: array;