https://github.com/samuelmarks/odbc-cli
CLI for basic CRUD across many databases using ODBC
https://github.com/samuelmarks/odbc-cli
Last synced: 3 months ago
JSON representation
CLI for basic CRUD across many databases using ODBC
- Host: GitHub
- URL: https://github.com/samuelmarks/odbc-cli
- Owner: SamuelMarks
- License: apache-2.0
- Created: 2024-07-29T18:54:07.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T05:06:08.000Z (over 1 year ago)
- Last Synced: 2025-01-28T04:32:00.002Z (over 1 year ago)
- Language: Rust
- Size: 102 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
odbc-cli
========
[](http://unmaintained.tech)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/SamuelMarks/odbc-cli/actions/workflows/build-and-release.yml)
Database abstracted CLI—using Open Database Connectivity (ODBC)—intended for basic and batch Create Read Update Delete (CRUD) operations, and negotiating database connection using a secret manager.
NOTE: You may need to install `unixodbc` on macOS, Linux (though the provided `musl` binary has it statically linked), and others; and on Windows you may need to install the ODBC driver for your database. For example, PostgreSQL: https://www.postgresql.org/ftp/odbc/releases/
## Usage
### Example
Start an ODBC compatible database. For example, to start PostgreSQL with `docker`:
docker run -p 5432:5432 -e POSTGRES_USER=rest_user -e POSTGRES_PASSWORD=rest_pass -e POSTGRES_DB=rest_db postgres:alpine
(will start and initialise a new PostgreSQL instance accessible via connection string `postgresql://rest_user:rest_pass@127.0.0.1:5432/rest_db`)
Now you can execute `odbc-cli` (or `cargo run -- --conn […]`):
odbc-cli \
--conn "Driver={PostgreSQL UNICODE};Server=localhost;Port=5432;Database=rest_db;Uid=rest_user;Password=rest_pass;" \
-c "SELECT atan(1)*4 AS pi"
### Vault / OpenBao
To avoid explicitly providing credential information, you can use Vault / OpenBao.
First, start or point to your secret store: [OpenBao](https://openbao.org) || [Hashicorp Vault](https://www.vaultproject.io) || [AWS Secret Engine](https://developer.hashicorp.com/vault/api-docs/secret/aws).
For example, for **testing only**, after [installing `bao` (guide)](https://openbao.org/docs/install):
VAULT_TOKEN='dev-only-token'
bao server -dev -dev-root-token-id="$VAULT_TOKEN"
(`docker run openbao/openbao` will do similar if you prefer Docker)
Then you can populate the secret store like so:
odbc-cli \
--conn "Driver={PostgreSQL UNICODE};Server=localhost;Port=5432;Database=rest_db;Uid=rest_user;Password=rest_pass;" \
--store-secret \
-c "SELECT version();"
(there's also a full Docker Compose example in the root of this repo)
#### Secret store environment variables
- `VAULT_ADDR`
- `VAULT_CACERT`
- `VAULT_CAPATH`
- `VAULT_CLIENT_CERT`
- `VAULT_CLIENT_KEY`
- `VAULT_SKIP_VERIFY`
- `VAULT_TOKEN`
### `--help`
CLI for basic CRUD across many databases using ODBC
Usage: odbc-cli [OPTIONS]
Options:
-d, --data-source-name
DataSourceName
--hostname
Hostname to connect with
--port
Port to connect with
--database
Database name to connect to
-u, --username
Username to connect as
-P, --password
Password to connect with
--conn
Connect string to connect with. Takes precedence over `data_source_name`, `username`, `password`
-c, --command
Query to execute
-f, --command-file
Alternative query to execute from file or stdin
-p, --params
Parameters to provide sanitarily to SQL query `--command`
--secret-store-engine
Secret storage service engine name [default: vault] [possible values: infisical, vault]
-a, --address
Secret storage service address [env: VAULT_ADDR=]
--ca-cert
Secret storage Certificate Authority (CA) certificate [env: VAULT_CACERT=]
--ca-path
Secret storage CA path [env: VAULT_CAPATH=]
--client-cert
Secret storage client certificate [env: VAULT_CLIENT_CERT=]
--client-key
Secret storage client key [env: VAULT_CLIENT_KEY=]
--skip-verify
Whether to skip verification on secret storage [env: VAULT_SKIP_VERIFY=] [possible values: true, false]
--token
Secret storage service vault token [env: VAULT_TOKEN=]
--store-secret
Whether to store the provided `connection_string` in the secret store
--secret-mount
mount of secret within secret storage engine
--secret-path
path of secret within secret storage engine
--output-format
Output format for SQL query result [default: csv] [possible values: csv, json, parquet]
--print-connection-str-and-exit
Whether to just print the connection string and then exit
-v, --verbose...
Increase logging verbosity
-q, --quiet...
Decrease logging verbosity
-h, --help
Print help
-V, --version
Print version
---
## Development guide
### Install Rust
Follow the [official alt-guide](https://forge.rust-lang.org/infra/other-installation-methods.html#other-ways-to-install-rustup) or alternatively run one of the following:
#### Non-Windows
```sh
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh sh -s -- --default-toolchain nightly
```
#### Windows
```cmd
> curl --proto '=https' --tlsv1.2 -sSfO https://static.rust-lang.org/rustup/dist/i686-pc-windows-gnu/rustup-init.exe
> rustup-init --default-toolchain nightly
```
### Build and run project
```sh
$ cargo run
```
### Docker
```sh
$ docker build . -t odbc-cli:latest
```
#### Docker Compose
```sh
$ docker compose up
```
Then if you want to be fancy and get the executable out so it can be added to the releases:
```sh
$ docker save odbc-cli:latest -o odbc-cli.tar
# Find and extract the binary, for example:
$ odbc-cli.tar\blobs\sha256\7e3cb62b89edc58a47effa0f9a4e1fa792d3013911ab29f6bcbd6b60a64b5ffb\usr\local\bin\odbc-cli
$ mv odbc-cli odbc-cli-x86_64-unknown-linux-musl
# Upload this manually to the release or run
$ gh release upload "tag-name" "odbc-cli-x86_64-unknown-linux-musl"
```
## Contribution guide
Ensure all tests are passing [`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html) and [`rustfmt`](https://github.com/rust-lang/rustfmt) has been run. This can be with [`cargo make`](https://github.com/sagiegurari/cargo-make); installable with:
```sh
$ cargo install --force cargo-make
```
Then run:
```sh
$ cargo make
```
Finally, we recommend [feature-branches](https://martinfowler.com/bliki/FeatureBranch.html) with an accompanying [pull-request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.