Skip to content

Commit a1aaa7e

Browse files
committed
RDoc-2354 Client configuration view (for database) v7.1
1 parent 4a80bcc commit a1aaa7e

File tree

6 files changed

+64
-47
lines changed

6 files changed

+64
-47
lines changed
221 KB
Loading
22.8 KB
Loading
Binary file not shown.

docs/studio/database/settings/client-configuration-per-database.mdx

Lines changed: 50 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -30,51 +30,60 @@ import Panel from '@site/src/components/Panel';
3030
For example, adjusting load balancing behavior on the fly in response to changing system demands.
3131

3232
* In this article:
33-
* [Set the client configuration (for database)](../../todo)
33+
* [Set the client configuration (for database)](../../../studio/database/settings/client-configuration-per-database.mdx#set-the-client-configuration-for-database)
3434

3535
</Admonition>
3636

37-
## Set the client configuration (for database)
37+
<Panel heading="Set the client configuration (for database)">
3838

39-
![Figure 1. Client Configuration Per Database](./assets/client-configuration-database-1.png)
40-
41-
42-
**1. Identity parts separator**
43-
44-
* Changes the default **separator** for automatically generated document IDs.
45-
You can use any `char` except `|` (pipe).
46-
Default value: `/`
47-
48-
**2. Max number of requests per session**
49-
50-
* Set this number to restrict the number of requests (***Reads*** & ***Writes***) per session in the client API.
51-
Default value: 30
52-
53-
**3. Use Session Context for Load Balancing**
54-
55-
* Allow client sessions to select their topology by tag,
56-
so they'd be able to load-balance their requests.
57-
58-
* Optionally, select a hash seed to randomize the topology that clients would use.
59-
60-
* For a detailed explanation see: [Load Balance Behavior](../../../client-api/configuration/load-balance/load-balance-behavior.mdx).
61-
62-
**4. Read balance behavior**
63-
64-
* Set the load-balance method that the client will use when accessing a node with ***Read*** requests.
65-
The method selected will also affect the client's decision of which node to failover to in case of issues with the ***Read*** request.
66-
Note: ***Write*** requests will always access the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) calculated by the client.
67-
68-
* Available options are:
69-
* _None_
70-
* _Round Robin_
71-
* _Fastest Node_
72-
73-
* For a detailed explanation see: [Read Balance Behavior](../../../client-api/configuration/load-balance/read-balance-behavior.mdx).
39+
![Figure 1. Client Configuration Per Database](./assets/client-configuration-1.png)
40+
41+
1. Go to **Settings > Client Configuration**
7442

75-
<Admonition type="info" title="Note" id="note" href="#note">
43+
2. Select whether to override the server-wide client configuration:
44+
Toggle **"Use server config"** to make this database use the settings defined [server-wide](../../../studio/server/client-configuration.mdx).
45+
Toggle **"Use database config"** to override the server-wide settings with a configuration specific to this database.
46+
47+
3. **Identity parts separator**
48+
Set the **separator character** for automatically generated document IDs of type **identity**.
49+
You can use any single character except `|` (pipe).
50+
Default value: `/`
51+
This setting affects only IDs for identity documents created by the server.
52+
Learn more about identities in [Document identifier generation: Identity](../../../server/kb/document-identifier-generation.mdx#strategy-identity).
53+
54+
4. **Maximum number of requests per session**
55+
Set this number to restrict the number of requests (***Reads*** & ***Writes***) allowed per session when using the Client API.
56+
Default value: `30`
57+
58+
5. **Load balance behavior**
59+
Set the Load balance method for ***Read*** & ***Write*** requests.
60+
For a detailed explanation see: [Load balance behavior](../../../client-api/configuration/load-balance/load-balance-behavior.mdx).
61+
62+
Available options:
63+
* [None](../../../client-api/configuration/load-balance/load-balance-behavior.mdx#none-default-option): (default)
64+
Read requests - the node the client will target will be based on the "Read balance behavior" configuration.
65+
Write requests - will be sent to the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node).
66+
* [Use session context](../../../client-api/configuration/load-balance/load-balance-behavior.mdx#usesessioncontext):
67+
Select this option to allow sessions to control load balancing using a "context string".
68+
With this option selected, the session determines the target node for all ***Read*** & ***Write*** requests by **hashing**:
69+
* the session's "context string" (set in the client session),
70+
* and an optional seed value (set here or in the client session).
71+
72+
All sessions that use the same "context string" and the same seed will route their requests to the same node.
73+
This gives you fine-grained control over how requests are distributed across the cluster based on how you assign "context strings" and "seeds".
74+
![Using session context](./assets/client-configuration-2.png)
75+
76+
6. **Read balance behavior**
77+
Set the "Read_ balance method" the client will use when accessing a node with ***Read*** requests.
78+
The selected method also affects how the client chooses a failover node for ***Read*** requests.
79+
For a detailed explanation see: [Read balance behavior](../../../client-api/configuration/load-balance/read-balance-behavior.mdx).
80+
81+
Available options:
82+
* [None](../../../client-api/configuration/load-balance/read-balance-behavior.mdx#none-default-option) (default)
83+
* [Round Robin](../../../client-api/configuration/load-balance/read-balance-behavior.mdx#roundrobin)
84+
* [Fastest Node](../../../client-api/configuration/load-balance/read-balance-behavior.mdx#fastestnode)
7685

77-
This view will be as in the above image when the general server [Client Configuration](../../../studio/server/client-configuration.mdx) is not yet defined.
78-
If a general server client-configuration is defined then this view will show the __effective configuration__ for the specific database.
86+
7. **Save**
87+
Click _Save_ to apply the changes.
7988

80-
</Admonition>
89+
</Panel>
2.75 KB
Loading

docs/studio/server/client-configuration.mdx

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,30 @@ import Panel from '@site/src/components/Panel';
5959
For a detailed explanation see: [Load balance behavior](../../client-api/configuration/load-balance/load-balance-behavior.mdx).
6060

6161
Available options:
62-
* [None](../../client-api/configuration/load-balance/load-balance-behavior.mdx#none-default-option):
62+
* [None](../../client-api/configuration/load-balance/load-balance-behavior.mdx#none-default-option): (default)
6363
Read requests - the node the client will target will be based on the "Read balance behavior" configuration.
6464
Write requests - will be sent to the [preferred node](../../client-api/configuration/load-balance/overview.mdx#the-preferred-node).
6565
* [Use session context](../../client-api/configuration/load-balance/load-balance-behavior.mdx#usesessioncontext):
66-
Sessions that are assigned the same context will have all their _Read_ & _Write_ requests routed to the same node.
67-
The session context is hashed from a context string (given by the client) and an optional `seed`.
66+
Select this option to allow sessions to control load balancing using a "context string".
67+
With this option selected, the session determines the target node for all ***Read*** & ***Write*** requests by **hashing**:
68+
* the session's "context string" (set in the client session),
69+
* and an optional seed value (set here or in the client session).
70+
71+
All sessions that use the same "context string" and the same seed will route their requests to the same node.
72+
This gives you fine-grained control over how requests are distributed across the cluster based on how you assign "context strings" and "seeds".
6873
![Using session context](./assets/client-configuration-2.png)
6974

7075
5. **Read balance behavior**
71-
Set the "Read_ balance method" the client will use when accessing a node with ***Read*** requests.
72-
The method selected will also affect the client's decision of which node to failover to in case of issues with the ***Read*** request.
76+
Set the "Read_ balance method" the client will use when accessing a node with ***Read*** requests.
77+
The selected method also affects how the client chooses a failover node for ***Read*** requests.
7378
For a detailed explanation see: [Read balance behavior](../../client-api/configuration/load-balance/read-balance-behavior.mdx).
7479

7580
Available options:
76-
* [None](../../client-api/configuration/load-balance/read-balance-behavior.mdx#none-default-option)
81+
* [None](../../client-api/configuration/load-balance/read-balance-behavior.mdx#none-default-option) (default)
7782
* [Round Robin](../../client-api/configuration/load-balance/read-balance-behavior.mdx#roundrobin)
7883
* [Fastest Node](../../client-api/configuration/load-balance/read-balance-behavior.mdx#fastestnode)
7984

85+
6. **Save**
86+
Click _Save_ to apply the changes.
87+
8088
</Panel>

0 commit comments

Comments
 (0)