Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 2.92 KB

put-serverwide-client-configuration.js.markdown

File metadata and controls

62 lines (37 loc) · 2.92 KB
Raw

Put Client Configuration Operation (Server-Wide)

{NOTE: }

  • The server-wide Client-Configuration is a set of configuration options that are set on the server and apply to any client when communicating with any database in the cluster.
    See the available configuration options in the article about put client-configuration for database.

  • To set the server-wide Client-Configuration on the server:

    • Use PutServerWideClientConfigurationOperation from the client code.
      See the example below.

    • Or, set the server-wide Client-Configuration from the Studio Client-Configuration view.

  • A Client-Configuration that is set on the server overrides the initial Client-Configuration that is set on the client when creating the Document Store.
    A Client-Configuration that is set on the server for the database level will override the server-wide Client-Configuration for that database.

  • Once the Client-Configuration is modified on the server, the running client will receive the updated settings the next time it makes a request to the database.

{NOTE /}

{PANEL: Put client-configuration (server-wide)}

{CODE:nodejs put_config@ClientApi\Operations\Server\putClientConfig.js /}

{PANEL/}

{PANEL: Syntax}

{CODE:nodejs syntax_1@ClientApi\Operations\Server\putClientConfig.js /}

Parameter Type Description
configuration object Client configuration that will be set on the server
(server-wide, for all databases)

{CODE:nodejs syntax_2@ClientApi\Operations\Server\putClientConfig.js /}

{PANEL/}

Related Articles

Studio

Operations