ClientOptions

Typed configuration object for {@see \oihana\arango\clients\ArangoClient}.

Tags

author

Marc Alcaraz (ekameleon)

since

1.0.0

Table of Contents

Constants

ALLOW_DIRTY_READ  : string = 'allowDirtyRead'

Array key — opt into dirty reads on a cluster deployment (`x-arango-allow-dirty-read: true` header on every request).

AUTH_TYPE  : string = 'authType'

Array key — authentication scheme; expected value is one of {@see AuthType}.

BATCH_SIZE  : string = 'batchSize'

Array key — default cursor batch size (int).

CONNECT_TIMEOUT  : string = 'connectTimeout'

Array key — TCP / TLS handshake timeout in seconds.

CONNECTION  : string = 'connection'

Array key — HTTP connection persistence mode; one of {@see ConnectionMode}.

CREATE  : string = 'create'

Array key — when true, auto-create collections on insert if missing.

DATABASE  : string = 'database'

Array key — target database name.

DEBUG  : string = 'debug'

Array key — enable verbose error logging.

DEFAULT_BATCH_SIZE  : int = 1000

Built-in default for {@see $batchSize} when none is provided.

DEFAULT_CONNECT_TIMEOUT  : int = 5

Built-in default for {@see $connectTimeout} (in seconds) when none is provided. Matches Guzzle's own default and arangojs's `agentOptions` connect window.

DEFAULT_TIMEOUT  : int = 30

Built-in default for {@see $timeout} (in seconds) when none is provided.

ENDPOINT  : string = 'endpoint'

Array key — single endpoint URL (for example `tcp://127.0.0.1:8529`).

ENDPOINTS  : string = 'endpoints'

Array key — ordered list of endpoints for cluster failover; takes precedence over {@see ENDPOINT}.

MAX_RUNTIME  : string = 'maxRuntime'

Array key — server-side max runtime per query, in seconds (null = unlimited).

PASSWORD  : string = 'password'

Array key — basic auth password (when authType = BASIC).

RECONNECT  : string = 'reconnect'

Array key — auto-reconnect when a keep-alive connection has timed out on the server.

REQUEST_TIMEOUT  : string = 'requestTimeout'

Array key — full-request timeout in seconds (Guzzle `timeout`).

TIMEOUT  : string = 'timeout'

Array key — legacy single-knob timeout in seconds. Aliases {@see REQUEST_TIMEOUT} when the latter is omitted.

TOKEN  : string = 'token'

Array key — JWT token (when authType = JWT).

TYPE  : string = 'type'

Array key — legacy alias of {@see AUTH_TYPE} kept for TOML backwards compatibility.

USER  : string = 'user'

Array key — basic auth user (when authType = BASIC).

Properties

$allowDirtyRead  : bool

$authType  : string

$batchSize  : int

$connection  : string

$connectTimeout  : int|float

$create  : bool

$database  : string|null

$debug  : bool

$endpoints  : array<string|int, mixed>

$maxRuntime  : int|float|null

$password  : string|null

$reconnect  : bool

$requestTimeout  : int|float

Full-request timeout in seconds (Guzzle `timeout`). When the caller did not pass `requestTimeout` to the constructor, this value mirrors {@see $timeout} so the legacy single-knob configuration keeps working unchanged.

$timeout  : int|float

$token  : string|null

$user  : string|null

Methods

__construct()  : mixed

endpoint()  : string|null

Returns the preferred endpoint (first entry of {@see $endpoints}) or null when none is configured.

fromArray()  : self

Builds a ClientOptions instance from a free-form configuration array (typically the `[arango]` section of a TOML file).