mirror of
https://github.com/nushell/nushell
synced 2025-01-16 23:24:14 +00:00
e290fa0e68
# Description
This PR adds the `stor` family of commands. These commands are meant to
create, open, insert, update, delete, reset data in an in-memory sqlite
database. This is really an experiment to see how creatively we can use
an in-memory database.
```
Usage:
> stor
Subcommands:
stor create - Create a table in the in-memory sqlite database
stor delete - Delete a table or specified rows in the in-memory sqlite database
stor export - Export the in-memory sqlite database to a sqlite database file
stor import - Import a sqlite database file into the in-memory sqlite database
stor insert - Insert information into a specified table in the in-memory sqlite database
stor open - Opens the in-memory sqlite database
stor reset - Reset the in-memory database by dropping all tables
stor update - Update information in a specified table in the in-memory sqlite database
Flags:
-h, --help - Display the help message for this command
Input/output types:
╭─#─┬──input──┬─output─╮
│ 0 │ nothing │ string │
╰───┴─────────┴────────╯
```
### Examples
## stor create
```nushell
❯ stor create --table-name nudb --columns {bool1: bool, int1: int, float1: float, str1: str, datetime1: datetime}
╭──────┬────────────────╮
│ nudb │ [list 0 items] │
╰──────┴────────────────╯
```
## stor insert
```nushell
❯ stor insert --table-name nudb --data-record {bool1: true, int1: 2, float1: 1.1, str1: fdncred, datetime1: 2023-04-17}
╭──────┬───────────────╮
│ nudb │ [table 1 row] │
╰──────┴───────────────╯
```
## stor open
```nushell
❯ stor open | table -e
╭──────┬────────────────────────────────────────────────────────────────────╮
│ │ ╭─#─┬id─┬bool1┬int1┬float1┬──str1───┬─────────datetime1──────────╮ │
│ nudb │ │ 0 │ 1 │ 1 │ 2 │ 1.10 │ fdncred │ 2023-04-17 00:00:00 +00:00 │ │
│ │ ╰───┴───┴─────┴────┴──────┴─────────┴────────────────────────────╯ │
╰──────┴────────────────────────────────────────────────────────────────────╯
```
## stor update
```nushell
❯ stor update --table-name nudb --update-record {str1: toby datetime1: 2021-04-17} --where-clause "bool1 = 1"
╭──────┬───────────────╮
│ nudb │ [table 1 row] │
╰──────┴───────────────╯
❯ stor open | table -e
╭──────┬─────────────────────────────────────────────────────────────────╮
│ │ ╭─#─┬id─┬bool1┬int1┬float1┬─str1─┬─────────datetime1──────────╮ │
│ nudb │ │ 0 │ 1 │ 1 │ 2 │ 1.10 │ toby │ 2021-04-17 00:00:00 +00:00 │ │
│ │ ╰───┴───┴─────┴────┴──────┴──────┴────────────────────────────╯ │
╰──────┴─────────────────────────────────────────────────────────────────╯
```
## insert another row
```nushell
❯ stor insert --table-name nudb --data-record {bool1: true, int1: 5, float1: 1.1, str1: fdncred, datetime1: 2023-04-17}
╭──────┬────────────────╮
│ nudb │ [table 2 rows] │
╰──────┴────────────────╯
❯ stor open | table -e
╭──────┬────────────────────────────────────────────────────────────────────╮
│ │ ╭─#─┬id─┬bool1┬int1┬float1┬──str1───┬─────────datetime1──────────╮ │
│ nudb │ │ 0 │ 1 │ 1 │ 2 │ 1.10 │ toby │ 2021-04-17 00:00:00 +00:00 │ │
│ │ │ 1 │ 2 │ 1 │ 5 │ 1.10 │ fdncred │ 2023-04-17 00:00:00 +00:00 │ │
│ │ ╰───┴───┴─────┴────┴──────┴─────────┴────────────────────────────╯ │
╰──────┴────────────────────────────────────────────────────────────────────╯
```
## stor delete (specific row(s))
```nushell
❯ stor delete --table-name nudb --where-clause "int1 == 5"
╭──────┬───────────────╮
│ nudb │ [table 1 row] │
╰──────┴───────────────╯
```
## insert multiple tables
```nushell
❯ stor create --table-name nudb1 --columns {bool1: bool, int1: int, float1: float, str1: str, datetime1: datetime}
╭───────┬────────────────╮
│ nudb │ [table 1 row] │
│ nudb1 │ [list 0 items] │
╰───────┴────────────────╯
❯ stor insert --table-name nudb1 --data-record {bool1: true, int1: 2, float1: 1.1, str1: fdncred, datetime1: 2023-04-17}
╭───────┬───────────────╮
│ nudb │ [table 1 row] │
│ nudb1 │ [table 1 row] │
╰───────┴───────────────╯
❯ stor create --table-name nudb2 --columns {bool1: bool, int1: int, float1: float, str1: str, datetime1: datetime}
╭───────┬────────────────╮
│ nudb │ [table 1 row] │
│ nudb1 │ [table 1 row] │
│ nudb2 │ [list 0 items] │
╰───────┴────────────────╯
❯ stor insert --table-name nudb2 --data-record {bool1: true, int1: 2, float1: 1.1, str1: fdncred, datetime1: 2023-04-17}
╭───────┬───────────────╮
│ nudb │ [table 1 row] │
│ nudb1 │ [table 1 row] │
│ nudb2 │ [table 1 row] │
╰───────┴───────────────╯
```
## stor delete (specific table)
```nushell
❯ stor delete --table-name nudb1
╭───────┬───────────────╮
│ nudb │ [table 1 row] │
│ nudb2 │ [table 1 row] │
╰───────┴───────────────╯
```
## stor reset (all tables are deleted)
```nushell
❯ stor reset
```
## stor export
```nushell
❯ stor export --file-name nudb.sqlite3
╭──────┬───────────────╮
│ nudb │ [table 1 row] │
╰──────┴───────────────╯
❯ open nudb.sqlite3 | table -e
╭──────┬────────────────────────────────────────────────────────────────────╮
│ │ ╭─#─┬id─┬bool1┬int1┬float1┬──str1───┬─────────datetime1──────────╮ │
│ nudb │ │ 0 │ 1 │ 1 │ 5 │ 1.10 │ fdncred │ 2023-04-17 00:00:00 +00:00 │ │
│ │ ╰───┴───┴─────┴────┴──────┴─────────┴────────────────────────────╯ │
╰──────┴────────────────────────────────────────────────────────────────────╯
❯ open nudb.sqlite3 | schema | table -e
╭────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ │ ╭──────┬──────────────────────────────────────────────────────────────────────────────────────────────────╮ │
│ tables │ │ │ ╭───────────────┬──────────────────────────────────────────────────────────────────────────────╮ │ │
│ │ │ nudb │ │ │ ╭─#─┬─cid─┬───name────┬─────type─────┬─notnull─┬───────default────────┬─pk─╮ │ │ │
│ │ │ │ │ columns │ │ 0 │ 0 │ id │ INTEGER │ 1 │ │ 1 │ │ │ │
│ │ │ │ │ │ │ 1 │ 1 │ bool1 │ BOOLEAN │ 0 │ │ 0 │ │ │ │
│ │ │ │ │ │ │ 2 │ 2 │ int1 │ INTEGER │ 0 │ │ 0 │ │ │ │
│ │ │ │ │ │ │ 3 │ 3 │ float1 │ REAL │ 0 │ │ 0 │ │ │ │
│ │ │ │ │ │ │ 4 │ 4 │ str1 │ VARCHAR(255) │ 0 │ │ 0 │ │ │ │
│ │ │ │ │ │ │ 5 │ 5 │ datetime1 │ DATETIME │ 0 │ STRFTIME('%Y-%m-%d │ 0 │ │ │ │
│ │ │ │ │ │ │ │ │ │ │ │ %H:%M:%f', 'NOW') │ │ │ │ │
│ │ │ │ │ │ ╰─#─┴─cid─┴───name────┴─────type─────┴─notnull─┴───────default────────┴─pk─╯ │ │ │
│ │ │ │ │ constraints │ [list 0 items] │ │ │
│ │ │ │ │ foreign_keys │ [list 0 items] │ │ │
│ │ │ │ │ indexes │ [list 0 items] │ │ │
│ │ │ │ ╰───────────────┴──────────────────────────────────────────────────────────────────────────────╯ │ │
│ │ ╰──────┴──────────────────────────────────────────────────────────────────────────────────────────────────╯ │
╰────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
## Using with `query db`
```nushell
❯ stor open | query db "select * from nudb"
╭─#─┬id─┬bool1┬int1┬float1┬──str1───┬─────────datetime1──────────╮
│ 0 │ 1 │ 1 │ 5 │ 1.10 │ fdncred │ 2023-04-17 00:00:00 +00:00 │
╰───┴───┴─────┴────┴──────┴─────────┴────────────────────────────╯
```
## stor import
```nushell
❯ stor open
# note, nothing is returned. there is nothing in memory, atm.
❯ stor import --file-name nudb.sqlite3
╭──────┬───────────────╮
│ nudb │ [table 1 row] │
╰──────┴───────────────╯
❯ stor open | table -e
╭──────┬────────────────────────────────────────────────────────────────────╮
│ │ ╭─#─┬id─┬bool1┬int1┬float1┬──str1───┬─────────datetime1──────────╮ │
│ nudb │ │ 0 │ 1 │ 1 │ 5 │ 1.10 │ fdncred │ 2023-04-17 00:00:00 +00:00 │ │
│ │ ╰───┴───┴─────┴────┴──────┴─────────┴────────────────────────────╯ │
╰──────┴────────────────────────────────────────────────────────────────────╯
```
TODO:
- [x] `stor export` - Export a fully formed sqlite db file.
- [x] `stor import` - Imports a specified sqlite db file.
- [x] Perhaps feature-gate it with the sqlite feature
- [x] Update `query db` to work with the in-memory database
- [x] Remove `open --in-memory`
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.
Make sure you've run and fixed any issues with these commands:
- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library
> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->
# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
141 lines
4.2 KiB
TOML
141 lines
4.2 KiB
TOML
[package]
|
|
authors = ["The Nushell Project Developers"]
|
|
description = "Nushell's built-in commands"
|
|
edition = "2021"
|
|
license = "MIT"
|
|
name = "nu-command"
|
|
repository = "https://github.com/nushell/nushell/tree/main/crates/nu-command"
|
|
version = "0.87.2"
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
[lib]
|
|
bench = false
|
|
|
|
[dependencies]
|
|
nu-ansi-term = "0.49.0"
|
|
nu-cmd-base = { path = "../nu-cmd-base", version = "0.87.2" }
|
|
nu-color-config = { path = "../nu-color-config", version = "0.87.2" }
|
|
nu-engine = { path = "../nu-engine", version = "0.87.2" }
|
|
nu-glob = { path = "../nu-glob", version = "0.87.2" }
|
|
nu-json = { path = "../nu-json", version = "0.87.2" }
|
|
nu-parser = { path = "../nu-parser", version = "0.87.2" }
|
|
nu-path = { path = "../nu-path", version = "0.87.2" }
|
|
nu-pretty-hex = { path = "../nu-pretty-hex", version = "0.87.2" }
|
|
nu-protocol = { path = "../nu-protocol", version = "0.87.2" }
|
|
nu-system = { path = "../nu-system", version = "0.87.2" }
|
|
nu-table = { path = "../nu-table", version = "0.87.2" }
|
|
nu-term-grid = { path = "../nu-term-grid", version = "0.87.2" }
|
|
nu-utils = { path = "../nu-utils", version = "0.87.2" }
|
|
|
|
alphanumeric-sort = "1.5"
|
|
base64 = "0.21"
|
|
byteorder = "1.5"
|
|
bytesize = "1.3"
|
|
calamine = "0.22"
|
|
chrono = { version = "0.4", features = ["std", "unstable-locales"], default-features = false }
|
|
chrono-humanize = "0.2.3"
|
|
chrono-tz = "0.8"
|
|
crossterm = "0.27"
|
|
csv = "1.3"
|
|
dialoguer = { default-features = false, features = ["fuzzy-select"], version = "0.11" }
|
|
digest = { default-features = false, version = "0.10" }
|
|
dtparse = "2.0"
|
|
encoding_rs = "0.8"
|
|
fancy-regex = "0.11"
|
|
filesize = "0.2"
|
|
filetime = "0.2"
|
|
fs_extra = "1.3"
|
|
htmlescape = "0.3"
|
|
human-date-parser = "0.1.1"
|
|
indexmap = "2.1"
|
|
indicatif = "0.17"
|
|
itertools = "0.11"
|
|
log = "0.4"
|
|
lscolors = { version = "0.15", default-features = false, features = ["nu-ansi-term"] }
|
|
md5 = { package = "md-5", version = "0.10" }
|
|
miette = { version = "5.10", features = ["fancy-no-backtrace"] }
|
|
mime = "0.3"
|
|
mime_guess = "2.0"
|
|
native-tls = "0.2"
|
|
notify-debouncer-full = { version = "0.3", default-features = false }
|
|
num = { version = "0.4", optional = true }
|
|
num-format = { version = "0.4" }
|
|
num-traits = "0.2"
|
|
once_cell = "1.18"
|
|
open = "5.0"
|
|
os_pipe = "1.1"
|
|
pathdiff = "0.2"
|
|
percent-encoding = "2.3"
|
|
print-positions = "0.6"
|
|
quick-xml = "0.30"
|
|
rand = "0.8"
|
|
rayon = "1.8"
|
|
regex = "1.9.5"
|
|
roxmltree = "0.18"
|
|
rusqlite = { version = "0.29", features = ["bundled", "backup"], optional = true }
|
|
same-file = "1.0"
|
|
serde = { version = "1.0", features = ["derive"] }
|
|
serde_json = "1.0"
|
|
serde_urlencoded = "0.7"
|
|
serde_yaml = "0.9"
|
|
sha2 = "0.10"
|
|
sysinfo = "0.29"
|
|
tabled = { version = "0.14.0", features = ["color"], default-features = false }
|
|
terminal_size = "0.3"
|
|
titlecase = "2.0"
|
|
toml = "0.8"
|
|
unicode-segmentation = "1.10"
|
|
ureq = { version = "2.8", default-features = false, features = ["charset", "gzip", "json", "native-tls"] }
|
|
url = "2.2"
|
|
uu_cp = "0.0.23"
|
|
uu_whoami = "0.0.23"
|
|
uu_mkdir = "0.0.23"
|
|
uu_mktemp = "0.0.23"
|
|
uuid = { version = "1.6", features = ["v4"] }
|
|
wax = { version = "0.6" }
|
|
which = { version = "5.0", optional = true }
|
|
bracoxide = "0.1.2"
|
|
chardetng = "0.1.17"
|
|
|
|
[target.'cfg(windows)'.dependencies]
|
|
winreg = "0.52"
|
|
|
|
[target.'cfg(unix)'.dependencies]
|
|
libc = "0.2"
|
|
umask = "2.1"
|
|
nix = { version = "0.27", default-features = false, features = ["user"] }
|
|
|
|
[target.'cfg(all(unix, not(target_os = "macos"), not(target_os = "android"), not(target_os = "ios")))'.dependencies]
|
|
procfs = "0.16.0"
|
|
|
|
[target.'cfg(not(any(target_os = "android", target_os = "ios")))'.dependencies.trash]
|
|
optional = true
|
|
version = "3.1"
|
|
|
|
[target.'cfg(windows)'.dependencies.windows]
|
|
features = [
|
|
"Win32_Foundation",
|
|
"Win32_Storage_FileSystem",
|
|
"Win32_System_Environment",
|
|
"Win32_System_SystemServices",
|
|
"Win32_Security",
|
|
"Win32_System_Threading",
|
|
]
|
|
version = "0.48"
|
|
|
|
[features]
|
|
plugin = ["nu-parser/plugin"]
|
|
sqlite = ["rusqlite"]
|
|
trash-support = ["trash"]
|
|
which-support = ["which"]
|
|
|
|
[dev-dependencies]
|
|
nu-cmd-lang = { path = "../nu-cmd-lang", version = "0.87.2" }
|
|
nu-test-support = { path = "../nu-test-support", version = "0.87.2" }
|
|
|
|
dirs-next = "2.0"
|
|
mockito = { version = "1.2", default-features = false }
|
|
quickcheck = "1.0"
|
|
quickcheck_macros = "1.0"
|
|
rstest = { version = "0.18", default-features = false }
|