Put Client Configuration Operation
(for database)

The following client-configuration options are available:

• Identity parts separator:
  Set the separator used with automatically generated document identity IDs (default separator is /).
  Learn more about identity IDs creation here.

• Maximum number of requests per session:
  Set this number to restrict the number of requests (Reads & Writes) per session in the client API.

• Read balance behavior:
  Set the Read balance method the client will use when accessing a node with Read requests.
  Learn more in Balancing client requests - overview and Read balance behavior.

• Load balance behavior:
  Set the Load balance method for Read & Write requests.
  Learn more in Load balance behavior.

// You can customize the client-configuration options in the client
// when creating the Document Store (this is optional):
// =================================================================

var documentStore = new DocumentStore
{
    Urls = new[] { "ServerURL_1", "ServerURL_2", "..." },
    Database = "DefaultDB",
    Conventions = new DocumentConventions
    {
        // Initialize some client-configuration options:
        MaxNumberOfRequestsPerSession = 100,
        IdentityPartsSeparator = '$'
        // ...
    }
}.Initialize();

// Override the initial client-configuration in the server using the put operation:
// ================================================================================

using (documentStore)
{
    // Define the client-configuration object
    ClientConfiguration clientConfiguration = new ClientConfiguration
    {
        MaxNumberOfRequestsPerSession = 200,
        ReadBalanceBehavior = ReadBalanceBehavior.FastestNode
        // ...
    };
        
    // Define the put client-configuration operation, pass the configuration 
    var putClientConfigOp = new PutClientConfigurationOperation(clientConfiguration);
    
    // Execute the operation by passing it to Maintenance.Send
    documentStore.Maintenance.Send(putClientConfigOp);
}

// Override the initial client-configuration using the put operation:
using (documentStore)
{
    // Define the client-configuration object
    ClientConfiguration clientConfiguration = new ClientConfiguration
    {
        MaxNumberOfRequestsPerSession = 200,
        ReadBalanceBehavior = ReadBalanceBehavior.FastestNode
        // ...
    };
        
    // Define the put client-configuration operation, pass the configuration 
    var putClientConfigOp = new PutClientConfigurationOperation(clientConfiguration);
    
    // Execute the operation by passing it to Maintenance.SendAsync
    await documentStore.Maintenance.SendAsync(putClientConfigOp);
}

public PutClientConfigurationOperation(ClientConfiguration configuration)

public class ClientConfiguration
{
    public long Etag { get; set; }
    public bool Disabled { get; set; }
    public int? MaxNumberOfRequestsPerSession { get; set; }
    public ReadBalanceBehavior? ReadBalanceBehavior { get; set; }
    public LoadBalanceBehavior? LoadBalanceBehavior { get; set; }
    public int? LoadBalancerContextSeed { get; set; }
    public char? IdentityPartsSeparator;  // can be any character except '|'
}