Metadata-Version: 2.5
Name: nivaria
Version: 0.12.1
Summary: A TUI for quickly browsing and searching Snowflake objects
Author-email: René de Hesselle <dehesselle@web.de>
License-Expression: 0BSD
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: platformdirs>=4.11.0
Requires-Dist: snowflake-connector-python[secure-local-storage]<5,>=4.7.3
Requires-Dist: tcoda<0.12,>=0.11.0
Requires-Dist: textual<9,>=8.2.8
Description-Content-Type: text/markdown

# Nivaria

![main screen](https://raw.githubusercontent.com/dehesselle/nivaria/master/docs/screenshot.svg)

> __Nivarius, nivaria, nivarium__ · _Latin adjective_
>
> “Of snow”, “belonging to snow” or “snow-related”. _Nivaria_ is its feminine singular form.

Nivaria is a [Textual](https://textual.textualize.io)-based TUI to browse and search objects in Snowflake: databases,
schemas, tables, views, pipes, stages and tasks, with their columns, grants,
tags, load and run history, and a preview of table data.

It reads everything from a local cache and refreshes it in the background, so
browsing and fuzzy search are instant even across thousands of objects. The
object tree comes from `SHOW` commands, which need no running warehouse, and a
small pool of connections is opened once, so an MFA-protected account prompts
at login rather than on every query.

## Install and run

```sh
uv tool install nivaria
nivaria
```

Enter your account and user in the connect dialog, pick an authenticator
(OAuth, browser SSO or password + MFA) and connect. `, a d` selects the
databases to browse, `/` searches, and `,` followed by a pause lists all
commands.

## Caveats

- The Data tab and the activity, history and tag columns run `SELECT`s on the
  active warehouse, which consumes credits. The tree and object lists do not.

## Documentation

- [docs/MANUAL.md](https://github.com/dehesselle/nivaria/blob/master/docs/MANUAL.md) — connecting, keys, browsing, search, detail views and all settings.
- [docs/OPERATIONS.md](https://github.com/dehesselle/nivaria/blob/master/docs/OPERATIONS.md) — Snowflake load, warehouse and privilege needs, limits, files on disk, troubleshooting.
- [docs/DESIGN.md](https://github.com/dehesselle/nivaria/blob/master/docs/DESIGN.md) — architecture, core principles and the reasons behind them.
- [docs/DEVELOPMENT.md](https://github.com/dehesselle/nivaria/blob/master/docs/DEVELOPMENT.md) — setup, tests, linting, conventions and live-account tools.
- [docs/data-retrieval.md](https://github.com/dehesselle/nivaria/blob/master/docs/data-retrieval.md) — what each screen and trigger sends to Snowflake.
- [docs/snowflake-behavior.md](https://github.com/dehesselle/nivaria/blob/master/docs/snowflake-behavior.md) — what live Snowflake accounts were observed to do.
- [docs/measurements.md](https://github.com/dehesselle/nivaria/blob/master/docs/measurements.md) — timings and data volumes behind the design.

## AI disclosure

Substantial parts of this code were generated with Sonnet 5.x/Opus 5.x. Generated code was tested, but not every line was reviewed in detail.

## License

[0BSD](https://github.com/dehesselle/nivaria/blob/master/LICENSES/0BSD.txt)
