-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1710 from Danielle9897/RDoc-2534-databaseConfigSe…
…ttings RDoc-2534 Database settings operations
- Loading branch information
Showing
15 changed files
with
669 additions
and
10 deletions.
There are no files selected for viewing
6 changes: 6 additions & 0 deletions
6
.../5.2/Raven.Documentation.Pages/client-api/operations/maintenance/configuration/.docs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
...perations/maintenance/configuration/database-settings-operation.dotnet.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| # Database Settings Operations | ||
|
|
||
| --- | ||
|
|
||
| {NOTE: } | ||
|
|
||
| * The default database configuration settings can be customized: | ||
|
|
||
| * From the Client API - as described in this article. | ||
|
|
||
| * From the Studio - via the [Database Settings View](../../../../studio/database/settings/database-settings#database-settings). | ||
|
|
||
| * In this page: | ||
|
|
||
| * [Put database settings operation](../../../../client-api/operations/maintenance/configuration/database-settings-operation#put-database-settings-operation) | ||
|
|
||
| * [Get database settings operation](../../../../client-api/operations/maintenance/configuration/database-settings-operation#get-database-settings-operation) | ||
|
|
||
| {WARNING: } | ||
| Do not modify the database settings unless you are an expert and know what you're doing. | ||
| {WARNING/} | ||
|
|
||
| {NOTE/} | ||
|
|
||
| {PANEL: Put database settings operation} | ||
|
|
||
| * Use `PutDatabaseSettingsOperation` to modify the default database configuration. | ||
|
|
||
| * Only __database-level__ settings can be customized using this operation. | ||
| See article [Configuration overview](../../../../server/configuration/configuration-options) to learn how to customize the __server-level__ settings. | ||
|
|
||
| * Note: for the changes to take effect, the database must be __reloaded__. | ||
| Reloading is accomplished by disabling and enabling the database using [ToggleDatabasesStateOperation](../../../../client-api/operations/server-wide/toggle-databases-state). | ||
| See the following example: | ||
|
|
||
| {CODE-TABS} | ||
| {CODE-TAB:csharp:Sync put_database_settings@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
| {CODE-TAB:csharp:Async put_database_settings_async@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
| {CODE-TABS/} | ||
|
|
||
| --- | ||
|
|
||
| __Syntax__: | ||
|
|
||
| {CODE syntax_1@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
|
|
||
| | Parameter | Type | Description | | ||
| |-----------------------|------------------------------|----------------------------------------------------| | ||
| | databaseName | `string` | Name of database for which to change the settings. | | ||
| | configurationSettings | `Dictionary<string, string>` | The configuration settings to set. | | ||
|
|
||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Get database settings operation} | ||
|
|
||
| * Use `GetDatabaseSettingsOperation` to get the configuration settings that were customized for the database. | ||
|
|
||
| * Only settings that have been changed will be retrieved. | ||
|
|
||
| {CODE-TABS} | ||
| {CODE-TAB:csharp:Sync get_database_settings@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
| {CODE-TAB:csharp:Async get_database_settings_async@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
| {CODE-TABS/} | ||
|
|
||
| --- | ||
|
|
||
| __Syntax__: | ||
|
|
||
| {CODE syntax_2@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
|
|
||
| | Parameter | Type | Description | | ||
| |--------------|----------|-------------------------------------------------------------| | ||
| | databaseName | `string` | The database name for which to get the customized settings. | | ||
|
|
||
|
|
||
| {CODE syntax_3@ClientApi\Operations\Maintenance\Configuration\DatabaseSettings.cs /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related Articles | ||
|
|
||
| ### Studio | ||
|
|
||
| - [Database settings view](../../../../studio/database/settings/database-settings#database-settings) | ||
|
|
||
| ### Operations | ||
|
|
||
| - [What are Operations](../../../../client-api/operations/what-are-operations) | ||
| - [How to Get Client Configuration](../../../../client-api/operations/maintenance/configuration/get-client-configuration) | ||
| - [How to Get Server-Wide Client Configuration](../../../../client-api/operations/server-wide/configuration/get-serverwide-client-configuration) | ||
| - [Toggle database state](../../../../client-api/operations/server-wide/toggle-databases-state) |
86 changes: 86 additions & 0 deletions
86
...pi/operations/maintenance/configuration/database-settings-operation.js.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # Database Settings Operations | ||
|
|
||
| --- | ||
|
|
||
| {NOTE: } | ||
|
|
||
| * The default database configuration settings can be customized: | ||
|
|
||
| * From the Client API - as described in this article. | ||
|
|
||
| * From the Studio - via the [Database Settings View](../../../../studio/database/settings/database-settings#database-settings). | ||
|
|
||
| * In this page: | ||
|
|
||
| * [Put database settings operation](../../../../client-api/operations/maintenance/configuration/database-settings-operation#put-database-settings-operation) | ||
|
|
||
| * [Get database settings operation](../../../../client-api/operations/maintenance/configuration/database-settings-operation#get-database-settings-operation) | ||
|
|
||
| {WARNING: } | ||
| Do not modify the database settings unless you are an expert and know what you're doing. | ||
| {WARNING/} | ||
|
|
||
| {NOTE/} | ||
|
|
||
| {PANEL: Put database settings operation} | ||
|
|
||
| * Use `PutDatabaseSettingsOperation` to modify the default database configuration. | ||
|
|
||
| * Only __database-level__ settings can be customized using this operation. | ||
| See article [Configuration overview](../../../../server/configuration/configuration-options) to learn how to customize the __server-level__ settings. | ||
|
|
||
| * Note: for the changes to take effect, the database must be __reloaded__. | ||
| Reloading is accomplished by disabling and enabling the database using [ToggleDatabasesStateOperation](../../../../client-api/operations/server-wide/toggle-databases-state). | ||
| See the following example: | ||
|
|
||
| {CODE:nodejs put_database_settings@ClientApi\Operations\Maintenance\Configuration\databaseSettings.js /} | ||
|
|
||
| --- | ||
|
|
||
| __Syntax__: | ||
|
|
||
| {CODE:nodejs syntax_1@ClientApi\Operations\Maintenance\Configuration\databaseSettings.js /} | ||
|
|
||
| | Parameter | Type | Description | | ||
| |-----------------------|-----------|----------------------------------------------------| | ||
| | databaseName | `string` | Name of database for which to change the settings. | | ||
| | configurationSettings | `object` | The configuration settings to set. | | ||
|
|
||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Get database settings operation} | ||
|
|
||
| * Use `GetDatabaseSettingsOperation` to get the configuration settings that were customized for the database. | ||
|
|
||
| * Only settings that have been changed will be retrieved. | ||
|
|
||
| {CODE:nodejs get_database_settings@ClientApi\Operations\Maintenance\Configuration\databaseSettings.js /} | ||
|
|
||
| --- | ||
|
|
||
| __Syntax__: | ||
|
|
||
| {CODE:nodejs syntax_2@ClientApi\Operations\Maintenance\Configuration\databaseSettings.js /} | ||
|
|
||
| | Parameter | Type | Description | | ||
| |--------------|----------|-------------------------------------------------------------| | ||
| | databaseName | `string` | The database name for which to get the customized settings. | | ||
|
|
||
|
|
||
| {CODE:nodejs syntax_3@ClientApi\Operations\Maintenance\Configuration\databaseSettings.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related Articles | ||
|
|
||
| ### Studio | ||
|
|
||
| - [Database settings view](../../../../studio/database/settings/database-settings#database-settings) | ||
|
|
||
| ### Operations | ||
|
|
||
| - [What are Operations](../../../../client-api/operations/what-are-operations) | ||
| - [How to Get Client Configuration](../../../../client-api/operations/maintenance/configuration/get-client-configuration) | ||
| - [How to Get Server-Wide Client Configuration](../../../../client-api/operations/server-wide/configuration/get-serverwide-client-configuration) | ||
| - [Toggle database state](../../../../client-api/operations/server-wide/toggle-databases-state) |
58 changes: 58 additions & 0 deletions
58
....Pages/client-api/operations/server-wide/toggle-databases-state.dotnet.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Toggle Databases State Operation <br> (Enable / Disable) | ||
| --- | ||
|
|
||
| {NOTE: } | ||
|
|
||
| * Use `ToggleDatabasesStateOperation` to enable/disable a single database or multiple databases. | ||
|
|
||
| * The database will be enabled/disabled on all nodes in the [database-group](../../../studio/database/settings/manage-database-group). | ||
|
|
||
| * In this page: | ||
|
|
||
| * [Enable database](../../../client-api/operations/server-wide/toggle-databases-state#enable-database) | ||
| * [Disable database](../../../client-api/operations/server-wide/toggle-databases-state#disable-database) | ||
| * [Syntax](../../../client-api/operations/server-wide/toggle-databases-state#syntax) | ||
|
|
||
| {NOTE/} | ||
|
|
||
| --- | ||
|
|
||
| {PANEL: Enable database} | ||
|
|
||
| {CODE-TABS} | ||
| {CODE-TAB:csharp:Sync enable@ClientApi\Operations\Server\ToggleDatabasesState.cs /} | ||
| {CODE-TAB:csharp:Async enable_async@ClientApi\Operations\Server\ToggleDatabasesState.cs /} | ||
| {CODE-TABS/} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Disable database} | ||
|
|
||
| {CODE-TABS} | ||
| {CODE-TAB:csharp:Sync disable@ClientApi\Operations\Server\ToggleDatabasesState.cs /} | ||
| {CODE-TAB:csharp:Async disable_async@ClientApi\Operations\Server\ToggleDatabasesState.cs /} | ||
| {CODE-TABS/} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Syntax} | ||
|
|
||
| {CODE syntax_1@ClientApi\Operations\Server\ToggleDatabasesState.cs /} | ||
|
|
||
| | Parameter | Type | Description | | ||
| |-------------------|----------|-------------------------------------------------------------------------------------------| | ||
| | __databaseName__ | string | Name of database for which to toggle state | | ||
| | __databaseNames__ | string[] | List of database names for which to toggle state | | ||
| | __disable__ | bool | `true` - request to disable the database(s)<br>`false`- request to enable the database(s) | | ||
|
|
||
| {CODE syntax_2@ClientApi\Operations\Server\ToggleDatabasesState.cs /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related Articles | ||
|
|
||
| ### Operations | ||
| - [Database settings operations](../../../client-api/operations/maintenance/configuration/database-settings-operation) | ||
|
|
||
| ### Studio | ||
| - [Database-group](../../../studio/database/settings/manage-database-group) |
52 changes: 52 additions & 0 deletions
52
...tion.Pages/client-api/operations/server-wide/toggle-databases-state.js.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Toggle Databases State Operation <br> (Enable / Disable) | ||
| --- | ||
|
|
||
| {NOTE: } | ||
|
|
||
| * Use `ToggleDatabasesStateOperation` to enable/disable a single database or multiple databases. | ||
|
|
||
| * The database will be enabled/disabled on all nodes in the [database-group](../../../studio/database/settings/manage-database-group). | ||
|
|
||
| * In this page: | ||
|
|
||
| * [Enable database](../../../client-api/operations/server-wide/toggle-databases-state#enable-database) | ||
| * [Disable database](../../../client-api/operations/server-wide/toggle-databases-state#disable-database) | ||
| * [Syntax](../../../client-api/operations/server-wide/toggle-databases-state#syntax) | ||
|
|
||
| {NOTE/} | ||
|
|
||
| --- | ||
|
|
||
| {PANEL: Enable database} | ||
|
|
||
| {CODE:nodejs enable@ClientApi\Operations\Server\toggleDatabasesState.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Disable database} | ||
|
|
||
| {CODE:nodejs disable@ClientApi\Operations\Server\toggleDatabasesState.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL: Syntax} | ||
|
|
||
| {CODE:nodejs syntax_1@ClientApi\Operations\Server\toggleDatabasesState.js /} | ||
|
|
||
| | Parameter | Type | Description | | ||
| |-------------------|----------|-------------------------------------------------------------------------------------------| | ||
| | __databaseName__ | string | Name of database for which to toggle state | | ||
| | __databaseNames__ | string[] | List of database names for which to toggle state | | ||
| | __disable__ | boolean | `true` - request to disable the database(s)<br>`false`- request to enable the database(s) | | ||
|
|
||
| {CODE:nodejs syntax_2@ClientApi\Operations\Server\toggleDatabasesState.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related Articles | ||
|
|
||
| ### Operations | ||
| - [Database settings operations](../../../client-api/operations/maintenance/configuration/database-settings-operation) | ||
|
|
||
| ### Studio | ||
| - [Database-group](../../../studio/database/settings/manage-database-group) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.