Skip to content

[CALCITE-5896] Document TLS client certificate JDBC URL options #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akashchamp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[CALCITE-5896] Document TLS client certificate JDBC URL options #324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions site/_docs/client_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,37 @@ on-hover images for the permalink, but oh well.

: _Required_: No.

<strong><a name="keystore" href="#keystore">keystore</a></strong>

: _Description_: A path to a Java KeyStore (JKS) file on the local filesystem
which contains the client's private key and certificate to present during
a TLS handshake for mutual TLS (mTLS) client certificate authentication.
Only necessary when the Avatica server requires clients to authenticate
with a certificate.

: _Default_: `null`.

: _Required_: No.

<strong><a name="keystore_password" href="#keystore_password">keystore_password</a></strong>

: _Description_: The password for the Java KeyStore file specified by <a href="#keystore">keystore</a>.

: _Default_: `null`.

: _Required_: Only if `keystore` was provided.

<strong><a name="key_password" href="#key_password">key_password</a></strong>

: _Description_: The password that protects the private key entry inside the
Java KeyStore file specified by <a href="#keystore">keystore</a>. This may
differ from <a href="#keystore_password">keystore_password</a> depending on
how the keystore was created.

: _Default_: `null`.

: _Required_: Only if `keystore` was provided.

<strong><a name="fetch_size" href="#fetch_size">fetch_size</a></strong>

: _Description_: The number of rows to fetch. If
Expand Down