ad5ad69d54
* Add 'Commands (CLI)' docs * Update index.mdx Added Environment variables section * Add 'connect' sub-folder structure * Adding listen address and port environment variables * add connect to the docs navigation * docs: Add Florin's update to index * docs: Fix links and typo * Add front-matter to resolve the PR check issue * Update postgres.mdx Boundary helper for POSTGRES * Completed 'boundary accounts' command docs * Draft connection option documentatino for kube, http, and rdp (#3455) * Style updates for consistency * Clean up using partials * Add 'ssh' doc & updated style for consistency * Fix paste error * Fix the format issue on 'connect ssh' doc * Add 'auth-methods' command doc (#3520) * Add the docs for 'logout', 'server', and 'dev' commands (#3524) * Add the docs for 'logout', 'server', and 'dev' commands * Update the front matter * Add auth-tokens and authenticate command docs (#3575) * Add config command docs (#3576) * updates to the ssh helper command docs (#3523) * updates to the ssh helper command docs * docs: Fix code block * docs: Add minor copy edits --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * docs: Add worker commands * docs: Update workers subcommands (#3598) * docs: Update worker subcommands * docs: Update certificate-authority subcommand * doc: Fix syntax for code refererences * docs: Add `users` commands (#3599) * docs: Add `users` commands * docs: Add more subcommands * docs: Add `target` commands (#3608) * Add command docs for 'credential-libraries' (#3610) * Add 'credential-stores' command docs (#3611) * Add 'credential-stores' command docs * Add the output message * Fix a typo * Fix a typo * Update the dummy token value * docs: Add `storage-bucket` commands - update (#3615) * docs: Add `sessions` commands (#3616) * docs: Add `session-recordings` commands (#3617) * Add 'credentials' command docs (#3619) * Add 'credentials' command docs * Fix typos * docs: Add `scopes` commands (#3620) * docs: Add `scopes` commands * docs: Fix typos * docs: Add `roles` commands (#3621) * docs: Add `roles` commands * docs: Add remaining subcommands * Add 'database' command docs (#3628) * Add 'database' command docs * Update the format inconsistency * docs: Add `managed-groups` commands (#3626) * docs: Add `managed-groups` commands * docs: Clarify description * docs: Add `hosts` commands (#3629) * docs: Add `host-sets` commands (#3630) * docs: Add `host-sets` commands * docs: Copy edits * docs: Add `host-catalogs` commands (#3632) * Add 'boundary groups' command docs (#3636) --------- Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com> Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com> Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
69 lines
2.0 KiB
Plaintext
69 lines
2.0 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: connect postgres - Command
|
|
description: |-
|
|
The "connect postgres" command performs a target authorization or consumes an existing authorization token, and launches a proxied postgres connection.
|
|
---
|
|
|
|
# connect postgres
|
|
|
|
Command: `boundary connect postgres`
|
|
|
|
The `connect postgres` command authorizes a session against a target and invokes a Postgres client for the connection.
|
|
The command fills in the local address and port.
|
|
|
|
@include 'cmd-connect-env-vars.mdx'
|
|
|
|
|
|
## Examples
|
|
|
|
The following example shows how to connect to a target with the ID `ttcp_eTcMueUYv` using a Postgres helper:
|
|
|
|
```shell-session
|
|
$ boundary connect postgres -target-id=ttcp_eTcZMueUYv \
|
|
-dbname=northwind \
|
|
-username=superuser \
|
|
-format=table
|
|
```
|
|
|
|
When prompted, you must enter the password for the user, "superuser":
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Password for user superuser:
|
|
psql (14.2, server 13.2 (Debian 13.2-1.pgdg100+1))
|
|
Type "help" for help.
|
|
|
|
postgres=#
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary connect postgres [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
@include 'cmd-connect-command-options.mdx'
|
|
|
|
### Postgres options:
|
|
|
|
- `-dbname` `(string: "")` - The database name you want to pass through to the client.
|
|
You can also specify the database name using the **BOUNDARY_CONNECT_DBNAME** environment variable.
|
|
|
|
- `-style` `(string: "")` - How the CLI attempts to invoke a Postgres client.
|
|
This value also sets a suitable default for `-exec`, if you did not specify a value.
|
|
The default and currently-understood value is `psql`.
|
|
You can also specify how the CLI attempts to invoke a Postgres client using the **BOUNDARY_CONNECT_POSTGRES_STYLE** environment variable.
|
|
|
|
- `-username` `(string: "")` - The username you want to pass through to the client.
|
|
This value may be overridden by credentials sourced from a credential store.
|
|
You can also specfiy a username using the **BOUNDARY_CONNECT_USERNAME** environment variable.
|
|
|
|
@include 'cmd-option-note.mdx' |