You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
--health-check Enable liveness and readiness checks ($HEALTH_CHECK)
61
-
--http-bind=":8000" Address to use to bind HTTP server used for health checks ($HTTP_BIND)
62
-
--heartbeat-interval=30s Interval between performing heartbeats to the cluster ($HEARTBEAT_INTERVAL)
63
-
--idle-timeout=60s Duration between successful heartbeats before a connection to the cluster is considered unresponsive and closed
64
-
($IDLE_TIMEOUT)
65
-
--readiness-timeout=30s Duration the proxy is unable to connect to the backend cluster before it is considered not ready
66
-
($READINESS_TIMEOUT)
67
-
--idempotent-graph If true it will treat all graph queries as idempotent by default and retry them automatically. It may be
68
-
dangerous to retry some graph queries -- use with caution ($IDEMPOTENT_GRAPH).
69
-
--num-conns=1 Number of connection to create to each node of the backend cluster ($NUM_CONNS)
70
-
--proxy-cert-file=STRING Path to a PEM encoded certificate file with its intermediate certificate chain. This is used to encrypt traffic
71
-
for proxy clients ($PROXY_CERT_FILE)
72
-
--proxy-key-file=STRING Path to a PEM encoded private key file. This is used to encrypt traffic for proxy clients ($PROXY_KEY_FILE)
73
-
--rpc-address=STRING Address to advertise in the 'system.local' table for'rpc_address'. It must be setif configuring peer proxies
74
-
($RPC_ADDRESS)
75
-
--data-center=STRING Data center to use in system tables ($DATA_CENTER)
76
-
--tokens=TOKENS,... Tokens to use in the system tables. It's not recommended ($TOKENS)
41
+
-h, --help Show context-sensitive help.
42
+
-b, --astra-bundle=STRING Path to secure connect bundle for an Astra database. Requires '--username' and '--password'. Ignored if using the token or contact points option ($ASTRA_BUNDLE).
43
+
-t, --astra-token=STRING Token used to authenticate to an Astra database. Requires '--astra-database-id'. Ignored if using the bundle path or contact points option ($ASTRA_TOKEN).
44
+
-i, --astra-database-id=STRING Database ID of the Astra database. Requires '--astra-token' ($ASTRA_DATABASE_ID)
45
+
--astra-api-url="https://api.astra.datastax.com" URL for the Astra API ($ASTRA_API_URL)
46
+
--astra-timeout=10s Timeout for contacting Astra when retrieving the bundle and metadata ($ASTRA_TIMEOUT)
47
+
-c, --contact-points=CONTACT-POINTS,... Contact points for cluster. Ignored if using the bundle path or token option ($CONTACT_POINTS).
48
+
-u, --username=STRING Username to use for authentication ($USERNAME)
49
+
-p, --password=STRING Password to use for authentication ($PASSWORD)
50
+
-r, --port=9042 Default port to use when connecting to cluster ($PORT)
51
+
-n, --protocol-version="v4" Initial protocol version to use when connecting to the backend cluster (default: v4, options: v3, v4, v5, DSEv1, DSEv2) ($PROTOCOL_VERSION)
52
+
-m, --max-protocol-version="v4" Max protocol version supported by the backend cluster (default: v4, options: v3, v4, v5, DSEv1, DSEv2) ($MAX_PROTOCOL_VERSION)
53
+
-a, --bind=":9042" Address to use to bind server ($BIND)
--health-check Enable liveness and readiness checks ($HEALTH_CHECK)
57
+
--http-bind=":8000" Address to use to bind HTTP server used for health checks ($HTTP_BIND)
58
+
--heartbeat-interval=30s Interval between performing heartbeats to the cluster ($HEARTBEAT_INTERVAL)
59
+
--connect-timeout=10s Duration before an attempt to connect to a cluster is considered timed out ($CONNECT_TIMEOUT)
60
+
--idle-timeout=60s Duration between successful heartbeats before a connection to the cluster is considered unresponsive and closed ($IDLE_TIMEOUT)
61
+
--readiness-timeout=30s Duration the proxy is unable to connect to the backend cluster before it is considered not ready ($READINESS_TIMEOUT)
62
+
--idempotent-graph If true it will treat all graph queries as idempotent by default and retry them automatically. It may be dangerous to retry some graph queries -- use with caution ($IDEMPOTENT_GRAPH).
63
+
--num-conns=1 Number of connection to create to each node of the backend cluster ($NUM_CONNS)
64
+
--proxy-cert-file=STRING Path to a PEM encoded certificate file with its intermediate certificate chain. This is used to encrypt traffic for proxy clients ($PROXY_CERT_FILE)
65
+
--proxy-key-file=STRING Path to a PEM encoded private key file. This is used to encrypt traffic for proxy clients ($PROXY_KEY_FILE)
66
+
--rpc-address=STRING Address to advertise in the 'system.local' table for'rpc_address'. It must be setif configuring peer proxies ($RPC_ADDRESS)
67
+
--data-center=STRING Data center to use in system tables ($DATA_CENTER)
68
+
--tokens=TOKENS,... Tokens to use in the system tables. It's not recommended ($TOKENS)
69
+
--unsupported-write-consistencies=UNSUPPORTED-WRITE-CONSISTENCIES,... A list of unsupported write consistency levels. The unsupported write consistency override setting will be used inplace of the unsupported level ($UNSUPPORTED_WRITE_CONSISTENCIES)
70
+
--unsupported-write-consistency-override=LOCAL_QUORUM A consistency level use to override unsupported write consistency levels
77
71
```
78
72
79
73
To pass configuration to `cql-proxy`, either command-line flags, environment variables, or a configuration file can be used. Using the `docker` method as an example, the following samples show how the token and database ID are defined with each method.
0 commit comments