org.projectnessie.nessie.cli.syntax.ConnectStatement.help.txt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nessie-cli-grammar Show documentation

There is a newer version: 0.101.3

Connect to a Nessie repository using the Nessie REST API base URI specified via `Uri`.

When using Nessie with Iceberg REST, it is recommended to use the Iceberg REST base URI
instead of the Nessie REST base URI.

Nessie client options can be specified using the `ParamKey = Value` pairs, see
https://projectnessie.org/nessie-latest/client_config/,

If the Nessie CLI is already connected to a Nessie repository, that connection will be closed.

Tip: If your connect string contains sensitive information, like a password or an access token,
put a space _before_ the `CONNECT` statement, which instructs the Nessie CLI to not record the
statement in the history file.

Examples:

* Local Nessie with Iceberg REST, using the default branch:
  `CONNECT TO http://127.0.0.1:19120/iceberg/` for a locally running Nessie instance with
  Iceberg REST (on your machine) without authentication enabled.
* Nessie with Iceberg REST, using another branch:
  `CONNECT TO http://127.0.0.1:19120/iceberg ON myBranch` for a locally running Nessie
  instance with Iceberg REST (on your machine) without authentication enabled, using `myBranch`
  as the initial reference name. Alternatively, you can add the initial reference name to
  the URI like this: `CONNECT TO http://127.0.0.1:19120/iceberg/myBranch`.
* Local Nessie:
  `CONNECT TO http://127.0.0.1:19120/api/v2` for a locally running Nessie instance (on your
  machine) without authentication enabled.
* Local Nessie:
  `CONNECT TO http://127.0.0.1:19120/api/v2 ON myBranch` for a locally running Nessie instance
  (on your machine) without authentication enabled, but using `myBranch` as the initial reference.
* Dremio Cloud:
  `CONNECT to https://app.dremio.cloud/repositories/beeff00d-1122-1234-4242-feedcafebabe/api/v2
    USING "nessie.authentication.type" = BEARER
    AND "nessie.authentication.token" = "your-personal-bearer-token"`
  to connect to Dremio Cloud. (The statement must not contain line breaks.)
  Replace `beeff00d-1122-1234-4242-feedcafebabe` with your project ID. The complete endpoint
  URI of your Dremio Cloud catalog can be found in the catalog settings
  as _Catalog Endpoint_ under _General Information_.
  Also replace `your-personal-bearer-token` with a personal token, which can be created in
  your account settings under _Personal Access Tokens_. Do never share a personal access token!

When using "interactive" OAuth2 device-code or authorization-code flows, you can abort the
login by pressing Ctrl-C.