diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 23a27992da..27f36cf7cb 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.93.0 +version: 0.94.0 core: | Alias a command (with optional flags) to a new name. usage: | diff --git a/commands/docs/all.md b/commands/docs/all.md index 3b89420929..fae7aee6fc 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Test if every element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/ansi.md b/commands/docs/ansi.md index a29f9cea78..11d39a080c 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Output ANSI codes to change color and style of text. usage: | @@ -143,8 +143,8 @@ Operating system commands: ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | ------------------------------------------------------------------ | -| [`ansi gradient`](/commands/docs/ansi_gradient.md) | Builtin | Add a color gradient (using ANSI color codes) to the given string. | -| [`ansi link`](/commands/docs/ansi_link.md) | Builtin | Add a link (using OSC 8 escape sequence) to the given string. | -| [`ansi strip`](/commands/docs/ansi_strip.md) | Builtin | Strip ANSI escape sequences from a string. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | ------------------------------------------------------------------ | -------- | +| [`ansi gradient`](/commands/docs/ansi_gradient.md) | Add a color gradient (using ANSI color codes) to the given string. | built-in | +| [`ansi link`](/commands/docs/ansi_link.md) | Add a link (using OSC 8 escape sequence) to the given string. | built-in | +| [`ansi strip`](/commands/docs/ansi_strip.md) | Strip ANSI escape sequences from a string. | built-in | \ No newline at end of file diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index 972706b530..c2eb0277e7 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Add a color gradient (using ANSI color codes) to the given string. usage: | diff --git a/commands/docs/ansi_link.md b/commands/docs/ansi_link.md index 724004f341..7bbc8958bc 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Add a link (using OSC 8 escape sequence) to the given string. usage: | diff --git a/commands/docs/ansi_strip.md b/commands/docs/ansi_strip.md index da405266bb..add642d44e 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index 61a57febc0..e4016587df 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Tests if any element of the input fulfills a predicate expression. usage: | diff --git a/commands/docs/append.md b/commands/docs/append.md index c231a98374..a1a4c19b54 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 268f767921..3bb044d2ac 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index de9d22d371..1ef6eb68b5 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Various commands for working with bits. usage: | @@ -31,13 +31,13 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------- | ------- | ----------------------------------------------- | -| [`bits and`](/commands/docs/bits_and.md) | Builtin | Performs bitwise and for ints or binary values. | -| [`bits not`](/commands/docs/bits_not.md) | Builtin | Performs logical negation on each bit. | -| [`bits or`](/commands/docs/bits_or.md) | Builtin | Performs bitwise or for ints or binary values. | -| [`bits rol`](/commands/docs/bits_rol.md) | Builtin | Bitwise rotate left for ints or binary values. | -| [`bits ror`](/commands/docs/bits_ror.md) | Builtin | Bitwise rotate right for ints or binary values. | -| [`bits shl`](/commands/docs/bits_shl.md) | Builtin | Bitwise shift left for ints or binary values. | -| [`bits shr`](/commands/docs/bits_shr.md) | Builtin | Bitwise shift right for ints or binary values. | -| [`bits xor`](/commands/docs/bits_xor.md) | Builtin | Performs bitwise xor for ints or binary values. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------- | ----------------------------------------------- | -------- | +| [`bits and`](/commands/docs/bits_and.md) | Performs bitwise and for ints or binary values. | built-in | +| [`bits not`](/commands/docs/bits_not.md) | Performs logical negation on each bit. | built-in | +| [`bits or`](/commands/docs/bits_or.md) | Performs bitwise or for ints or binary values. | built-in | +| [`bits rol`](/commands/docs/bits_rol.md) | Bitwise rotate left for ints or binary values. | built-in | +| [`bits ror`](/commands/docs/bits_ror.md) | Bitwise rotate right for ints or binary values. | built-in | +| [`bits shl`](/commands/docs/bits_shl.md) | Bitwise shift left for ints or binary values. | built-in | +| [`bits shr`](/commands/docs/bits_shr.md) | Bitwise shift right for ints or binary values. | built-in | +| [`bits xor`](/commands/docs/bits_xor.md) | Performs bitwise xor for ints or binary values. | built-in | \ No newline at end of file diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 477d2ea31e..bb7c263d1a 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Performs bitwise and for ints or binary values. usage: | diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index 2f8bf3ecf1..92f3800f41 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 70f982a0d2..8d8f224b97 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Performs bitwise or for ints or binary values. usage: | diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 9e0b2a61a8..c2810a02fd 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Bitwise rotate left for ints or binary values. usage: | diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 5ad7bdfae4..6e0ccda40d 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Bitwise rotate right for ints or binary values. usage: | diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 3211d3443a..5557330550 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Bitwise shift left for ints or binary values. usage: | diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index 54b3f0d76e..e05453f0bd 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Bitwise shift right for ints or binary values. usage: | diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index c0877bb404..97f820a8d3 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.93.0 +version: 0.94.0 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 3b4af56995..35fa1c05ae 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.93.0 +version: 0.94.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index cf655ae404..e01dc4dbd7 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Various commands for working with byte data. usage: | @@ -31,16 +31,16 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------ | -| [`bytes add`](/commands/docs/bytes_add.md) | Builtin | Add specified bytes to the input. | -| [`bytes at`](/commands/docs/bytes_at.md) | Builtin | Get bytes defined by a range. | -| [`bytes build`](/commands/docs/bytes_build.md) | Builtin | Create bytes from the arguments. | -| [`bytes collect`](/commands/docs/bytes_collect.md) | Builtin | Concatenate multiple binary into a single binary, with an optional separator between each. | -| [`bytes ends-with`](/commands/docs/bytes_ends-with.md) | Builtin | Check if bytes ends with a pattern. | -| [`bytes index-of`](/commands/docs/bytes_index-of.md) | Builtin | Returns start index of first occurrence of pattern in bytes, or -1 if no match. | -| [`bytes length`](/commands/docs/bytes_length.md) | Builtin | Output the length of any bytes in the pipeline. | -| [`bytes remove`](/commands/docs/bytes_remove.md) | Builtin | Remove bytes. | -| [`bytes replace`](/commands/docs/bytes_replace.md) | Builtin | Find and replace binary. | -| [`bytes reverse`](/commands/docs/bytes_reverse.md) | Builtin | Reverse the bytes in the pipeline. | -| [`bytes starts-with`](/commands/docs/bytes_starts-with.md) | Builtin | Check if bytes starts with a pattern. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------- | +| [`bytes add`](/commands/docs/bytes_add.md) | Add specified bytes to the input. | built-in | +| [`bytes at`](/commands/docs/bytes_at.md) | Get bytes defined by a range. | built-in | +| [`bytes build`](/commands/docs/bytes_build.md) | Create bytes from the arguments. | built-in | +| [`bytes collect`](/commands/docs/bytes_collect.md) | Concatenate multiple binary into a single binary, with an optional separator between each. | built-in | +| [`bytes ends-with`](/commands/docs/bytes_ends-with.md) | Check if bytes ends with a pattern. | built-in | +| [`bytes index-of`](/commands/docs/bytes_index-of.md) | Returns start index of first occurrence of pattern in bytes, or -1 if no match. | built-in | +| [`bytes length`](/commands/docs/bytes_length.md) | Output the length of any bytes in the pipeline. | built-in | +| [`bytes remove`](/commands/docs/bytes_remove.md) | Remove bytes. | built-in | +| [`bytes replace`](/commands/docs/bytes_replace.md) | Find and replace binary. | built-in | +| [`bytes reverse`](/commands/docs/bytes_reverse.md) | Reverse the bytes in the pipeline. | built-in | +| [`bytes starts-with`](/commands/docs/bytes_starts-with.md) | Check if bytes starts with a pattern. | built-in | \ No newline at end of file diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index f20a69b128..7381ebda10 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 522769dd58..e61c275cf3 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 997b30f0c8..760f17d7f9 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Create bytes from the arguments. usage: | @@ -39,3 +39,11 @@ Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii 00000000: 01 02 03 04 •••• ``` + +Builds binary data from byte numbers +```nu +> bytes build 255 254 253 252 +Length: 4 (0x4) bytes | printable whitespace ascii_other non_ascii +00000000: ff fe fd fc ×××× + +``` diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index cb402088a6..bd9a3903c2 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Concatenate multiple binary into a single binary, with an optional separator between each. usage: | diff --git a/commands/docs/bytes_ends-with.md b/commands/docs/bytes_ends-with.md index ed068b6dc3..21a6b214df 100644 --- a/commands/docs/bytes_ends-with.md +++ b/commands/docs/bytes_ends-with.md @@ -2,7 +2,7 @@ title: bytes ends-with categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Check if bytes ends with a pattern. usage: | diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index c2db107c06..51e51b1c9e 100644 --- a/commands/docs/bytes_index-of.md +++ b/commands/docs/bytes_index-of.md @@ -2,7 +2,7 @@ title: bytes index-of categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index 4074378dea..af29239c61 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Output the length of any bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_remove.md b/commands/docs/bytes_remove.md index 8f8480b97e..ba218435d4 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index d61c3c18db..bb18e35694 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 8a8d676e57..353c28787b 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index 9de2ceb770..bf99888362 100644 --- a/commands/docs/bytes_starts-with.md +++ b/commands/docs/bytes_starts-with.md @@ -2,7 +2,7 @@ title: bytes starts-with categories: | bytes -version: 0.93.0 +version: 0.94.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 0f2e3833d2..5a4008461b 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.93.0 +version: 0.94.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index d1efcc4ef5..4b2f7328bd 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Change directory. usage: | @@ -19,6 +19,10 @@ feature: default ```> cd {flags} (path)``` +## Flags + + - `--physical, -P`: use the physical directory structure; resolve symbolic links before processing instances of .. + ## Parameters - `path`: The path to change to. diff --git a/commands/docs/char.md b/commands/docs/char.md index 29046b2155..f1097c6f94 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index e0b7160ee3..74f7647415 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Clear the terminal. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index ce9bb2b478..a8105e89e4 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,18 +2,18 @@ title: collect categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | - Collect a stream into a value and then run a closure with the collected value as input. + Collect a stream into a value. usage: | - Collect a stream into a value and then run a closure with the collected value as input. + Collect a stream into a value. feature: default --- # `collect` for [filters](/commands/categories/filters.md) -
Collect a stream into a value and then run a closure with the collected value as input.
+
Collect a stream into a value.
## Signature @@ -44,6 +44,12 @@ Use the second value in the stream Read and write to the same file ```nu -> open file.txt | collect { save -f file.txt } +> open file.txt | collect | save -f file.txt ``` + +## Notes +If provided, run a closure with the collected value as input. + +The entire stream will be collected into one value in memory, so if the stream +is particularly large, this can cause high memory usage. \ No newline at end of file diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 941111d74a..df87520555 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Given a record or table, produce a list of its columns' names. usage: | diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index ec97bfd522..8bb39769b6 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.93.0 +version: 0.94.0 core: | View the current command line input buffer. usage: | @@ -29,8 +29,8 @@ feature: default ## Subcommands: -| name | type | usage | -| -------------------------------------------------------------------- | ------- | --------------------------------------------- | -| [`commandline edit`](/commands/docs/commandline_edit.md) | Builtin | Modify the current command line input buffer. | -| [`commandline get-cursor`](/commands/docs/commandline_get-cursor.md) | Builtin | Get the current cursor position. | -| [`commandline set-cursor`](/commands/docs/commandline_set-cursor.md) | Builtin | Set the current cursor position. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------------------------- | --------------------------------------------- | -------- | +| [`commandline edit`](/commands/docs/commandline_edit.md) | Modify the current command line input buffer. | built-in | +| [`commandline get-cursor`](/commands/docs/commandline_get-cursor.md) | Get the current cursor position. | built-in | +| [`commandline set-cursor`](/commands/docs/commandline_set-cursor.md) | Set the current cursor position. | built-in | \ No newline at end of file diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index c3d5931299..67fa994b03 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.93.0 +version: 0.94.0 core: | Modify the current command line input buffer. usage: | diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index d521cbbbfb..96c290c3d9 100644 --- a/commands/docs/commandline_get-cursor.md +++ b/commands/docs/commandline_get-cursor.md @@ -2,7 +2,7 @@ title: commandline get-cursor categories: | core -version: 0.93.0 +version: 0.94.0 core: | Get the current cursor position. usage: | diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 334917e414..658239e7e1 100644 --- a/commands/docs/commandline_set-cursor.md +++ b/commands/docs/commandline_set-cursor.md @@ -2,7 +2,7 @@ title: commandline set-cursor categories: | core -version: 0.93.0 +version: 0.94.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 048b11455c..726c90db27 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 53cf152d2c..550223279b 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.93.0 +version: 0.94.0 system: | Capture the outputs and exit code from an external piped in command in a nushell table. usage: | diff --git a/commands/docs/config.md b/commands/docs/config.md index 5dbc5ecef6..a88ab1b21a 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.93.0 +version: 0.94.0 env: | Edit nushell configuration files. usage: | @@ -31,8 +31,8 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| [`config env`](/commands/docs/config_env.md) | Builtin | Edit nu environment configurations. | -| [`config nu`](/commands/docs/config_nu.md) | Builtin | Edit nu configurations. | -| [`config reset`](/commands/docs/config_reset.md) | Builtin | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| [`config env`](/commands/docs/config_env.md) | Edit nu environment configurations. | built-in | +| [`config nu`](/commands/docs/config_nu.md) | Edit nu configurations. | built-in | +| [`config reset`](/commands/docs/config_reset.md) | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. | built-in | \ No newline at end of file diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 2739766986..cf43868aab 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.93.0 +version: 0.94.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 5e989fc674..633ba988a9 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.93.0 +version: 0.94.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 7d4192e1c9..bae2229b0c 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.93.0 +version: 0.94.0 env: | Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index 3707d383a4..0a8a00e329 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.93.0 +version: 0.94.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 11129b3b07..10603bd103 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.93.0 +version: 0.94.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 114da8e1cc..fbfd67c7d3 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index 971601eb5e..baa3bc5ee4 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.93.0 +version: 0.94.0 date: | Date-related commands. usage: | @@ -31,12 +31,12 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------------------ | ------- | --------------------------------------------------------- | -| [`date format`](/commands/docs/date_format.md) | Builtin | Removed command: use `format date` instead. | -| [`date humanize`](/commands/docs/date_humanize.md) | Builtin | Print a 'humanized' format for the date, relative to now. | -| [`date list-timezone`](/commands/docs/date_list-timezone.md) | Builtin | List supported time zones. | -| [`date now`](/commands/docs/date_now.md) | Builtin | Get the current date. | -| [`date to-record`](/commands/docs/date_to-record.md) | Builtin | Convert the date into a record. | -| [`date to-table`](/commands/docs/date_to-table.md) | Builtin | Convert the date into a structured table. | -| [`date to-timezone`](/commands/docs/date_to-timezone.md) | Builtin | Convert a date to a given time zone. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------------------ | --------------------------------------------------------- | -------- | +| [`date format`](/commands/docs/date_format.md) | Removed command: use `format date` instead. | built-in | +| [`date humanize`](/commands/docs/date_humanize.md) | Print a 'humanized' format for the date, relative to now. | built-in | +| [`date list-timezone`](/commands/docs/date_list-timezone.md) | List supported time zones. | built-in | +| [`date now`](/commands/docs/date_now.md) | Get the current date. | built-in | +| [`date to-record`](/commands/docs/date_to-record.md) | Convert the date into a record. | built-in | +| [`date to-table`](/commands/docs/date_to-table.md) | Convert the date into a structured table. | built-in | +| [`date to-timezone`](/commands/docs/date_to-timezone.md) | Convert a date to a given time zone. | built-in | \ No newline at end of file diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 448914e7a6..2aaaee439c 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.93.0 +version: 0.94.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index bb60fe28f4..0a7d0275e7 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.93.0 +version: 0.94.0 date: | Print a 'humanized' format for the date, relative to now. usage: | diff --git a/commands/docs/date_list-timezone.md b/commands/docs/date_list-timezone.md index 34f596d086..71835a5782 100644 --- a/commands/docs/date_list-timezone.md +++ b/commands/docs/date_list-timezone.md @@ -2,7 +2,7 @@ title: date list-timezone categories: | date -version: 0.93.0 +version: 0.94.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 2bd7f7b64b..ab33ab2b1c 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.93.0 +version: 0.94.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index d3546f9c38..3e25b88a98 100644 --- a/commands/docs/date_to-record.md +++ b/commands/docs/date_to-record.md @@ -2,7 +2,7 @@ title: date to-record categories: | date -version: 0.93.0 +version: 0.94.0 date: | Convert the date into a record. usage: | diff --git a/commands/docs/date_to-table.md b/commands/docs/date_to-table.md index e8585a9460..ef40968517 100644 --- a/commands/docs/date_to-table.md +++ b/commands/docs/date_to-table.md @@ -2,7 +2,7 @@ title: date to-table categories: | date -version: 0.93.0 +version: 0.94.0 date: | Convert the date into a structured table. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index 0fd1e13bed..bc66d7b4d0 100644 --- a/commands/docs/date_to-timezone.md +++ b/commands/docs/date_to-timezone.md @@ -2,7 +2,7 @@ title: date to-timezone categories: | date -version: 0.93.0 +version: 0.94.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index 93acd7201c..85ab46b6c5 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Debug print the value(s) piped in. usage: | @@ -61,7 +61,7 @@ Debug print a table ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | --------------------------------------- | -| [`debug info`](/commands/docs/debug_info.md) | Builtin | View process memory info. | -| [`debug profile`](/commands/docs/debug_profile.md) | Builtin | Profile pipeline elements in a closure. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | --------------------------------------- | -------- | +| [`debug info`](/commands/docs/debug_info.md) | View process memory info. | built-in | +| [`debug profile`](/commands/docs/debug_profile.md) | Profile pipeline elements in a closure. | built-in | \ No newline at end of file diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index a041727fbb..20852a0150 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 6422d8373a..55902a9444 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Profile pipeline elements in a closure. usage: | @@ -25,6 +25,7 @@ feature: default - `--expand-source, -e`: Collect full source fragments of profiled elements - `--values, -v`: Collect pipeline element output values - `--expr, -x`: Collect expression types + - `--lines, -l`: Collect line numbers - `--max-depth, -m {int}`: How many blocks/closures deep to step into (default 2) ## Parameters diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 25f09c4751..a608472987 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Decode bytes into a string. usage: | @@ -53,7 +53,7 @@ documentation link at https://docs.rs/encoding_rs/latest/encoding_rs/#statics ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | ---------------------- | -| [`decode base64`](/commands/docs/decode_base64.md) | Builtin | Base64 decode a value. | -| [`decode hex`](/commands/docs/decode_hex.md) | Builtin | Hex decode a value. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | ---------------------- | -------- | +| [`decode base64`](/commands/docs/decode_base64.md) | Base64 decode a value. | built-in | +| [`decode hex`](/commands/docs/decode_hex.md) | Hex decode a value. | built-in | \ No newline at end of file diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index 1ef2d9380c..1b67ccab4e 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.93.0 +version: 0.94.0 hash: | Base64 decode a value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index 2780e22a22..f3f8db14f2 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Hex decode a value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index 75c3b85d44..5a436246e4 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.93.0 +version: 0.94.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 60184511bd..fe46f4a4a0 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Sets a default row's column if missing. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index cecf569f36..3bb11ed012 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.93.0 +version: 0.94.0 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -23,7 +23,6 @@ feature: default - `--no-collect, -n`: do not collect streams of structured data - `--detailed, -d`: show detailed information about the value - - `--collect-lazyrecords, -l`: collect lazy records ## Input/output types: @@ -45,13 +44,11 @@ Describe the type of a record in a detailed way > {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| print $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d ╭─────────┬───────────────────────────────────────────────────────────╮ │ type │ record │ -│ lazy │ false │ │ │ ╭──────────────┬────────────────────────────────────────╮ │ │ columns │ │ shell │ string │ │ │ │ │ uwu │ bool │ │ │ │ │ │ ╭─────────┬──────────────────────────╮ │ │ │ │ │ features │ │ type │ record │ │ │ -│ │ │ │ │ lazy │ false │ │ │ │ │ │ │ │ │ ╭───────────────┬──────╮ │ │ │ │ │ │ │ │ columns │ │ bugs │ bool │ │ │ │ │ │ │ │ │ │ │ multiplatform │ bool │ │ │ │ diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 83a8acc073..37db617a0a 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/dexit.md b/commands/docs/dexit.md index 0575e87112..94aa91cafc 100644 --- a/commands/docs/dexit.md +++ b/commands/docs/dexit.md @@ -2,7 +2,7 @@ title: dexit categories: | shells -version: 0.92.0 +version: 0.94.0 shells: | Leaves a previously entered working directory. usage: | diff --git a/commands/docs/dfr.md b/commands/docs/dfr.md deleted file mode 100644 index e6d033088b..0000000000 --- a/commands/docs/dfr.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: dfr -categories: | - dataframe -version: 0.93.0 -dataframe: | - Operate with data in a dataframe format. -usage: | - Operate with data in a dataframe format. -feature: dataframe ---- - - -# `dfr` for [dataframe](/commands/categories/dataframe.md) - -
Operate with data in a dataframe format.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr {flags} ``` - - -## Input/output types: - -| input | output | -| ------- | ------ | -| nothing | string | - -## Notes -You must use one of the following subcommands. Using this command as-is will only produce this help message. - -## Subcommands: - -| name | type | usage | -| -------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------ | -| [`dfr agg`](/commands/docs/dfr_agg.md) | Builtin | Performs a series of aggregations from a group-by. | -| [`dfr agg-groups`](/commands/docs/dfr_agg-groups.md) | Builtin | Creates an agg_groups expression. | -| [`dfr all-false`](/commands/docs/dfr_all-false.md) | Builtin | Returns true if all values are false. | -| [`dfr all-true`](/commands/docs/dfr_all-true.md) | Builtin | Returns true if all values are true. | -| [`dfr append`](/commands/docs/dfr_append.md) | Builtin | Appends a new dataframe. | -| [`dfr arg-max`](/commands/docs/dfr_arg-max.md) | Builtin | Return index for max value in series. | -| [`dfr arg-min`](/commands/docs/dfr_arg-min.md) | Builtin | Return index for min value in series. | -| [`dfr arg-sort`](/commands/docs/dfr_arg-sort.md) | Builtin | Returns indexes for a sorted series. | -| [`dfr arg-true`](/commands/docs/dfr_arg-true.md) | Builtin | Returns indexes where values are true. | -| [`dfr arg-unique`](/commands/docs/dfr_arg-unique.md) | Builtin | Returns indexes for unique values. | -| [`dfr arg-where`](/commands/docs/dfr_arg-where.md) | Builtin | Creates an expression that returns the arguments where expression is true. | -| [`dfr as`](/commands/docs/dfr_as.md) | Builtin | Creates an alias expression. | -| [`dfr as-date`](/commands/docs/dfr_as-date.md) | Builtin | Converts string to date. | -| [`dfr as-datetime`](/commands/docs/dfr_as-datetime.md) | Builtin | Converts string to datetime. | -| [`dfr cache`](/commands/docs/dfr_cache.md) | Builtin | Caches operations in a new LazyFrame. | -| [`dfr cast`](/commands/docs/dfr_cast.md) | Builtin | Cast a column to a different dtype. | -| [`dfr col`](/commands/docs/dfr_col.md) | Builtin | Creates a named column expression. | -| [`dfr collect`](/commands/docs/dfr_collect.md) | Builtin | Collect lazy dataframe into eager dataframe. | -| [`dfr columns`](/commands/docs/dfr_columns.md) | Builtin | Show dataframe columns. | -| [`dfr concat-str`](/commands/docs/dfr_concat-str.md) | Builtin | Creates a concat string expression. | -| [`dfr concatenate`](/commands/docs/dfr_concatenate.md) | Builtin | Concatenates strings with other array. | -| [`dfr contains`](/commands/docs/dfr_contains.md) | Builtin | Checks if a pattern is contained in a string. | -| [`dfr count`](/commands/docs/dfr_count.md) | Builtin | Creates a count expression. | -| [`dfr count-null`](/commands/docs/dfr_count-null.md) | Builtin | Counts null values. | -| [`dfr cumulative`](/commands/docs/dfr_cumulative.md) | Builtin | Cumulative calculation for a series. | -| [`dfr datepart`](/commands/docs/dfr_datepart.md) | Builtin | Creates an expression for capturing the specified datepart in a column. | -| [`dfr drop`](/commands/docs/dfr_drop.md) | Builtin | Creates a new dataframe by dropping the selected columns. | -| [`dfr drop-duplicates`](/commands/docs/dfr_drop-duplicates.md) | Builtin | Drops duplicate values in dataframe. | -| [`dfr drop-nulls`](/commands/docs/dfr_drop-nulls.md) | Builtin | Drops null values in dataframe. | -| [`dfr dtypes`](/commands/docs/dfr_dtypes.md) | Builtin | Show dataframe data types. | -| [`dfr dummies`](/commands/docs/dfr_dummies.md) | Builtin | Creates a new dataframe with dummy variables. | -| [`dfr explode`](/commands/docs/dfr_explode.md) | Builtin | Explodes a dataframe or creates a explode expression. | -| [`dfr expr-not`](/commands/docs/dfr_expr-not.md) | Builtin | Creates a not expression. | -| [`dfr fetch`](/commands/docs/dfr_fetch.md) | Builtin | Collects the lazyframe to the selected rows. | -| [`dfr fill-nan`](/commands/docs/dfr_fill-nan.md) | Builtin | Replaces NaN values with the given expression. | -| [`dfr fill-null`](/commands/docs/dfr_fill-null.md) | Builtin | Replaces NULL values with the given expression. | -| [`dfr filter`](/commands/docs/dfr_filter.md) | Builtin | Filter dataframe based in expression. | -| [`dfr filter-with`](/commands/docs/dfr_filter-with.md) | Builtin | Filters dataframe using a mask or expression as reference. | -| [`dfr first`](/commands/docs/dfr_first.md) | Builtin | Show only the first number of rows or create a first expression | -| [`dfr flatten`](/commands/docs/dfr_flatten.md) | Builtin | An alias for dfr explode. | -| [`dfr get`](/commands/docs/dfr_get.md) | Builtin | Creates dataframe with the selected columns. | -| [`dfr get-day`](/commands/docs/dfr_get-day.md) | Builtin | Gets day from date. | -| [`dfr get-hour`](/commands/docs/dfr_get-hour.md) | Builtin | Gets hour from date. | -| [`dfr get-minute`](/commands/docs/dfr_get-minute.md) | Builtin | Gets minute from date. | -| [`dfr get-month`](/commands/docs/dfr_get-month.md) | Builtin | Gets month from date. | -| [`dfr get-nanosecond`](/commands/docs/dfr_get-nanosecond.md) | Builtin | Gets nanosecond from date. | -| [`dfr get-ordinal`](/commands/docs/dfr_get-ordinal.md) | Builtin | Gets ordinal from date. | -| [`dfr get-second`](/commands/docs/dfr_get-second.md) | Builtin | Gets second from date. | -| [`dfr get-week`](/commands/docs/dfr_get-week.md) | Builtin | Gets week from date. | -| [`dfr get-weekday`](/commands/docs/dfr_get-weekday.md) | Builtin | Gets weekday from date. | -| [`dfr get-year`](/commands/docs/dfr_get-year.md) | Builtin | Gets year from date. | -| [`dfr group-by`](/commands/docs/dfr_group-by.md) | Builtin | Creates a group-by object that can be used for other aggregations. | -| [`dfr implode`](/commands/docs/dfr_implode.md) | Builtin | Aggregates a group to a Series. | -| [`dfr into-df`](/commands/docs/dfr_into-df.md) | Builtin | Converts a list, table or record into a dataframe. | -| [`dfr into-lazy`](/commands/docs/dfr_into-lazy.md) | Builtin | Converts a dataframe into a lazy dataframe. | -| [`dfr into-nu`](/commands/docs/dfr_into-nu.md) | Builtin | Converts a dataframe or an expression into into nushell value for access and exploration. | -| [`dfr is-duplicated`](/commands/docs/dfr_is-duplicated.md) | Builtin | Creates mask indicating duplicated values. | -| [`dfr is-in`](/commands/docs/dfr_is-in.md) | Builtin | Creates an is-in expression. | -| [`dfr is-not-null`](/commands/docs/dfr_is-not-null.md) | Builtin | Creates mask where value is not null. | -| [`dfr is-null`](/commands/docs/dfr_is-null.md) | Builtin | Creates mask where value is null. | -| [`dfr is-unique`](/commands/docs/dfr_is-unique.md) | Builtin | Creates mask indicating unique values. | -| [`dfr join`](/commands/docs/dfr_join.md) | Builtin | Joins a lazy frame with other lazy frame. | -| [`dfr last`](/commands/docs/dfr_last.md) | Builtin | Creates new dataframe with tail rows or creates a last expression. | -| [`dfr lit`](/commands/docs/dfr_lit.md) | Builtin | Creates a literal expression. | -| [`dfr lowercase`](/commands/docs/dfr_lowercase.md) | Builtin | Lowercase the strings in the column. | -| [`dfr ls`](/commands/docs/dfr_ls.md) | Builtin | Lists stored dataframes. | -| [`dfr max`](/commands/docs/dfr_max.md) | Builtin | Creates a max expression or aggregates columns to their max value. | -| [`dfr mean`](/commands/docs/dfr_mean.md) | Builtin | Creates a mean expression for an aggregation or aggregates columns to their mean value. | -| [`dfr median`](/commands/docs/dfr_median.md) | Builtin | Aggregates columns to their median value | -| [`dfr melt`](/commands/docs/dfr_melt.md) | Builtin | Unpivot a DataFrame from wide to long format. | -| [`dfr min`](/commands/docs/dfr_min.md) | Builtin | Creates a min expression or aggregates columns to their min value. | -| [`dfr n-unique`](/commands/docs/dfr_n-unique.md) | Builtin | Counts unique values. | -| [`dfr not`](/commands/docs/dfr_not.md) | Builtin | Inverts boolean mask. | -| [`dfr open`](/commands/docs/dfr_open.md) | Builtin | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. | -| [`dfr otherwise`](/commands/docs/dfr_otherwise.md) | Builtin | Completes a when expression. | -| [`dfr quantile`](/commands/docs/dfr_quantile.md) | Builtin | Aggregates the columns to the selected quantile. | -| [`dfr query`](/commands/docs/dfr_query.md) | Builtin | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | -| [`dfr rename`](/commands/docs/dfr_rename.md) | Builtin | Rename a dataframe column. | -| [`dfr replace`](/commands/docs/dfr_replace.md) | Builtin | Replace the leftmost (sub)string by a regex pattern. | -| [`dfr replace-all`](/commands/docs/dfr_replace-all.md) | Builtin | Replace all (sub)strings by a regex pattern. | -| [`dfr reverse`](/commands/docs/dfr_reverse.md) | Builtin | Reverses the LazyFrame | -| [`dfr rolling`](/commands/docs/dfr_rolling.md) | Builtin | Rolling calculation for a series. | -| [`dfr sample`](/commands/docs/dfr_sample.md) | Builtin | Create sample dataframe. | -| [`dfr schema`](/commands/docs/dfr_schema.md) | Builtin | Show schema for a dataframe. | -| [`dfr select`](/commands/docs/dfr_select.md) | Builtin | Selects columns from lazyframe. | -| [`dfr set`](/commands/docs/dfr_set.md) | Builtin | Sets value where given mask is true. | -| [`dfr set-with-idx`](/commands/docs/dfr_set-with-idx.md) | Builtin | Sets value in the given index. | -| [`dfr shape`](/commands/docs/dfr_shape.md) | Builtin | Shows column and row size for a dataframe. | -| [`dfr shift`](/commands/docs/dfr_shift.md) | Builtin | Shifts the values by a given period. | -| [`dfr slice`](/commands/docs/dfr_slice.md) | Builtin | Creates new dataframe from a slice of rows. | -| [`dfr sort-by`](/commands/docs/dfr_sort-by.md) | Builtin | Sorts a lazy dataframe based on expression(s). | -| [`dfr std`](/commands/docs/dfr_std.md) | Builtin | Creates a std expression for an aggregation of std value from columns in a dataframe. | -| [`dfr str-lengths`](/commands/docs/dfr_str-lengths.md) | Builtin | Get lengths of all strings. | -| [`dfr str-slice`](/commands/docs/dfr_str-slice.md) | Builtin | Slices the string from the start position until the selected length. | -| [`dfr strftime`](/commands/docs/dfr_strftime.md) | Builtin | Formats date based on string rule. | -| [`dfr sum`](/commands/docs/dfr_sum.md) | Builtin | Creates a sum expression for an aggregation or aggregates columns to their sum value. | -| [`dfr summary`](/commands/docs/dfr_summary.md) | Builtin | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | -| [`dfr take`](/commands/docs/dfr_take.md) | Builtin | Creates new dataframe using the given indices. | -| [`dfr to-arrow`](/commands/docs/dfr_to-arrow.md) | Builtin | Saves dataframe to arrow file. | -| [`dfr to-avro`](/commands/docs/dfr_to-avro.md) | Builtin | Saves dataframe to avro file. | -| [`dfr to-csv`](/commands/docs/dfr_to-csv.md) | Builtin | Saves dataframe to CSV file. | -| [`dfr to-jsonl`](/commands/docs/dfr_to-jsonl.md) | Builtin | Saves dataframe to a JSON lines file. | -| [`dfr to-parquet`](/commands/docs/dfr_to-parquet.md) | Builtin | Saves dataframe to parquet file. | -| [`dfr unique`](/commands/docs/dfr_unique.md) | Builtin | Returns unique values from a dataframe. | -| [`dfr uppercase`](/commands/docs/dfr_uppercase.md) | Builtin | Uppercase the strings in the column. | -| [`dfr value-counts`](/commands/docs/dfr_value-counts.md) | Builtin | Returns a dataframe with the counts for unique values in series. | -| [`dfr var`](/commands/docs/dfr_var.md) | Builtin | Create a var expression for an aggregation. | -| [`dfr when`](/commands/docs/dfr_when.md) | Builtin | Creates and modifies a when expression. | -| [`dfr with-column`](/commands/docs/dfr_with-column.md) | Builtin | Adds a series to the dataframe. | \ No newline at end of file diff --git a/commands/docs/dfr_agg-groups.md b/commands/docs/dfr_agg-groups.md deleted file mode 100644 index 5433879105..0000000000 --- a/commands/docs/dfr_agg-groups.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: dfr agg-groups -categories: | - expression -version: 0.93.0 -expression: | - Creates an agg_groups expression. -usage: | - Creates an agg_groups expression. -feature: dataframe ---- - - -# `dfr agg-groups` for [expression](/commands/categories/expression.md) - -
Creates an agg_groups expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr agg-groups {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - - -```nu -> - -``` diff --git a/commands/docs/dfr_agg.md b/commands/docs/dfr_agg.md deleted file mode 100644 index b100d2eb3b..0000000000 --- a/commands/docs/dfr_agg.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: dfr agg -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Performs a series of aggregations from a group-by. -usage: | - Performs a series of aggregations from a group-by. -feature: dataframe ---- - - -# `dfr agg` for [lazyframe](/commands/categories/lazyframe.md) - -
Performs a series of aggregations from a group-by.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr agg {flags} ...rest``` - -## Parameters - - - `...rest`: Expression(s) that define the aggregations to be applied - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Group by and perform an aggregation -```nu -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr into-df - | dfr group-by a - | dfr agg [ - (dfr col b | dfr min | dfr as "b_min") - (dfr col b | dfr max | dfr as "b_max") - (dfr col b | dfr sum | dfr as "b_sum") - ] -╭───┬───┬───────┬───────┬───────╮ -│ # │ a │ b_min │ b_max │ b_sum │ -├───┼───┼───────┼───────┼───────┤ -│ 0 │ 1 │ 2 │ 4 │ 6 │ -│ 1 │ 2 │ 4 │ 6 │ 10 │ -╰───┴───┴───────┴───────┴───────╯ - -``` - -Group by and perform an aggregation -```nu -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr into-lazy - | dfr group-by a - | dfr agg [ - (dfr col b | dfr min | dfr as "b_min") - (dfr col b | dfr max | dfr as "b_max") - (dfr col b | dfr sum | dfr as "b_sum") - ] - | dfr collect -╭───┬───┬───────┬───────┬───────╮ -│ # │ a │ b_min │ b_max │ b_sum │ -├───┼───┼───────┼───────┼───────┤ -│ 0 │ 1 │ 2 │ 4 │ 6 │ -│ 1 │ 2 │ 4 │ 6 │ 10 │ -╰───┴───┴───────┴───────┴───────╯ - -``` diff --git a/commands/docs/dfr_all-false.md b/commands/docs/dfr_all-false.md deleted file mode 100644 index b83028e1aa..0000000000 --- a/commands/docs/dfr_all-false.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: dfr all-false -categories: | - dataframe -version: 0.93.0 -dataframe: | - Returns true if all values are false. -usage: | - Returns true if all values are false. -feature: dataframe ---- - - -# `dfr all-false` for [dataframe](/commands/categories/dataframe.md) - -
Returns true if all values are false.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr all-false {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns true if all values are false -```nu -> [false false false] | dfr into-df | dfr all-false -╭───┬───────────╮ -│ # │ all_false │ -├───┼───────────┤ -│ 0 │ true │ -╰───┴───────────╯ - -``` - -Checks the result from a comparison -```nu -> let s = ([5 6 2 10] | dfr into-df); - let res = ($s > 9); - $res | dfr all-false -╭───┬───────────╮ -│ # │ all_false │ -├───┼───────────┤ -│ 0 │ false │ -╰───┴───────────╯ - -``` diff --git a/commands/docs/dfr_all-true.md b/commands/docs/dfr_all-true.md deleted file mode 100644 index 348130c6ab..0000000000 --- a/commands/docs/dfr_all-true.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: dfr all-true -categories: | - dataframe -version: 0.93.0 -dataframe: | - Returns true if all values are true. -usage: | - Returns true if all values are true. -feature: dataframe ---- - - -# `dfr all-true` for [dataframe](/commands/categories/dataframe.md) - -
Returns true if all values are true.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr all-true {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns true if all values are true -```nu -> [true true true] | dfr into-df | dfr all-true -╭───┬──────────╮ -│ # │ all_true │ -├───┼──────────┤ -│ 0 │ true │ -╰───┴──────────╯ - -``` - -Checks the result from a comparison -```nu -> let s = ([5 6 2 8] | dfr into-df); - let res = ($s > 9); - $res | dfr all-true -╭───┬──────────╮ -│ # │ all_true │ -├───┼──────────┤ -│ 0 │ false │ -╰───┴──────────╯ - -``` diff --git a/commands/docs/dfr_append.md b/commands/docs/dfr_append.md deleted file mode 100644 index 8e113848e8..0000000000 --- a/commands/docs/dfr_append.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: dfr append -categories: | - dataframe -version: 0.93.0 -dataframe: | - Appends a new dataframe. -usage: | - Appends a new dataframe. -feature: dataframe ---- - - -# `dfr append` for [dataframe](/commands/categories/dataframe.md) - -
Appends a new dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr append {flags} (other)``` - -## Flags - - - `--col, -c`: appends in col orientation - -## Parameters - - - `other`: dataframe to be appended - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Appends a dataframe as new columns -```nu -> let a = ([[a b]; [1 2] [3 4]] | dfr into-df); - $a | dfr append $a -╭───┬───┬───┬─────┬─────╮ -│ # │ a │ b │ a_x │ b_x │ -├───┼───┼───┼─────┼─────┤ -│ 0 │ 1 │ 2 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ 3 │ 4 │ -╰───┴───┴───┴─────┴─────╯ - -``` - -Appends a dataframe merging at the end of columns -```nu -> let a = ([[a b]; [1 2] [3 4]] | dfr into-df); - $a | dfr append $a --col -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -│ 2 │ 1 │ 2 │ -│ 3 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_arg-max.md b/commands/docs/dfr_arg-max.md deleted file mode 100644 index e71c2d25f1..0000000000 --- a/commands/docs/dfr_arg-max.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: dfr arg-max -categories: | - dataframe -version: 0.93.0 -dataframe: | - Return index for max value in series. -usage: | - Return index for max value in series. -feature: dataframe ---- - - -# `dfr arg-max` for [dataframe](/commands/categories/dataframe.md) - -
Return index for max value in series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr arg-max {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns index for max value -```nu -> [1 3 2] | dfr into-df | dfr arg-max -╭───┬─────────╮ -│ # │ arg_max │ -├───┼─────────┤ -│ 0 │ 1 │ -╰───┴─────────╯ - -``` diff --git a/commands/docs/dfr_arg-min.md b/commands/docs/dfr_arg-min.md deleted file mode 100644 index 8afc68fc21..0000000000 --- a/commands/docs/dfr_arg-min.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: dfr arg-min -categories: | - dataframe -version: 0.93.0 -dataframe: | - Return index for min value in series. -usage: | - Return index for min value in series. -feature: dataframe ---- - - -# `dfr arg-min` for [dataframe](/commands/categories/dataframe.md) - -
Return index for min value in series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr arg-min {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns index for min value -```nu -> [1 3 2] | dfr into-df | dfr arg-min -╭───┬─────────╮ -│ # │ arg_min │ -├───┼─────────┤ -│ 0 │ 0 │ -╰───┴─────────╯ - -``` diff --git a/commands/docs/dfr_arg-sort.md b/commands/docs/dfr_arg-sort.md deleted file mode 100644 index 6806da8e59..0000000000 --- a/commands/docs/dfr_arg-sort.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: dfr arg-sort -categories: | - dataframe -version: 0.93.0 -dataframe: | - Returns indexes for a sorted series. -usage: | - Returns indexes for a sorted series. -feature: dataframe ---- - - -# `dfr arg-sort` for [dataframe](/commands/categories/dataframe.md) - -
Returns indexes for a sorted series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr arg-sort {flags} ``` - -## Flags - - - `--reverse, -r`: reverse order - - `--nulls-last, -n`: nulls ordered last - - `--maintain-order, -m`: maintain order on sorted items - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns indexes for a sorted series -```nu -> [1 2 2 3 3] | dfr into-df | dfr arg-sort -╭───┬──────────╮ -│ # │ arg_sort │ -├───┼──────────┤ -│ 0 │ 0 │ -│ 1 │ 1 │ -│ 2 │ 2 │ -│ 3 │ 3 │ -│ 4 │ 4 │ -╰───┴──────────╯ - -``` - -Returns indexes for a sorted series -```nu -> [1 2 2 3 3] | dfr into-df | dfr arg-sort --reverse -╭───┬──────────╮ -│ # │ arg_sort │ -├───┼──────────┤ -│ 0 │ 3 │ -│ 1 │ 4 │ -│ 2 │ 1 │ -│ 3 │ 2 │ -│ 4 │ 0 │ -╰───┴──────────╯ - -``` diff --git a/commands/docs/dfr_arg-true.md b/commands/docs/dfr_arg-true.md deleted file mode 100644 index 41af10f6cf..0000000000 --- a/commands/docs/dfr_arg-true.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: dfr arg-true -categories: | - dataframe -version: 0.93.0 -dataframe: | - Returns indexes where values are true. -usage: | - Returns indexes where values are true. -feature: dataframe ---- - - -# `dfr arg-true` for [dataframe](/commands/categories/dataframe.md) - -
Returns indexes where values are true.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr arg-true {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns indexes where values are true -```nu -> [false true false] | dfr into-df | dfr arg-true -╭───┬──────────╮ -│ # │ arg_true │ -├───┼──────────┤ -│ 0 │ 1 │ -╰───┴──────────╯ - -``` diff --git a/commands/docs/dfr_arg-unique.md b/commands/docs/dfr_arg-unique.md deleted file mode 100644 index de3a7c92b8..0000000000 --- a/commands/docs/dfr_arg-unique.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr arg-unique -categories: | - dataframe -version: 0.93.0 -dataframe: | - Returns indexes for unique values. -usage: | - Returns indexes for unique values. -feature: dataframe ---- - - -# `dfr arg-unique` for [dataframe](/commands/categories/dataframe.md) - -
Returns indexes for unique values.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr arg-unique {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns indexes for unique values -```nu -> [1 2 2 3 3] | dfr into-df | dfr arg-unique -╭───┬────────────╮ -│ # │ arg_unique │ -├───┼────────────┤ -│ 0 │ 0 │ -│ 1 │ 1 │ -│ 2 │ 3 │ -╰───┴────────────╯ - -``` diff --git a/commands/docs/dfr_arg-where.md b/commands/docs/dfr_arg-where.md deleted file mode 100644 index f0c8e9540e..0000000000 --- a/commands/docs/dfr_arg-where.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: dfr arg-where -categories: | - expression -version: 0.93.0 -expression: | - Creates an expression that returns the arguments where expression is true. -usage: | - Creates an expression that returns the arguments where expression is true. -feature: dataframe ---- - - -# `dfr arg-where` for [expression](/commands/categories/expression.md) - -
Creates an expression that returns the arguments where expression is true.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr arg-where {flags} (column name)``` - -## Parameters - - - `column name`: Expression to evaluate - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Return a dataframe where the value match the expression -```nu -> let df = ([[a b]; [one 1] [two 2] [three 3]] | dfr into-df); - $df | dfr select (dfr arg-where ((dfr col b) >= 2) | dfr as b_arg) -╭───┬───────╮ -│ # │ b_arg │ -├───┼───────┤ -│ 0 │ 1 │ -│ 1 │ 2 │ -╰───┴───────╯ - -``` diff --git a/commands/docs/dfr_as-date.md b/commands/docs/dfr_as-date.md deleted file mode 100644 index 8615d9a6fd..0000000000 --- a/commands/docs/dfr_as-date.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: dfr as-date -categories: | - dataframe -version: 0.93.0 -dataframe: | - Converts string to date. -usage: | - Converts string to date. -feature: dataframe ---- - - -# `dfr as-date` for [dataframe](/commands/categories/dataframe.md) - -
Converts string to date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr as-date {flags} (format)``` - -## Flags - - - `--not-exact, -n`: the format string may be contained in the date (e.g. foo-2021-01-01-bar could match 2021-01-01) - -## Parameters - - - `format`: formatting date string - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Converts string to date -```nu -> ["2021-12-30" "2021-12-31"] | dfr into-df | dfr as-datetime "%Y-%m-%d" - -``` - -## Notes -Format example: - "%Y-%m-%d" => 2021-12-31 - "%d-%m-%Y" => 31-12-2021 - "%Y%m%d" => 2021319 (2021-03-19) \ No newline at end of file diff --git a/commands/docs/dfr_as-datetime.md b/commands/docs/dfr_as-datetime.md deleted file mode 100644 index dfc8e1427d..0000000000 --- a/commands/docs/dfr_as-datetime.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: dfr as-datetime -categories: | - dataframe -version: 0.93.0 -dataframe: | - Converts string to datetime. -usage: | - Converts string to datetime. -feature: dataframe ---- - - -# `dfr as-datetime` for [dataframe](/commands/categories/dataframe.md) - -
Converts string to datetime.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr as-datetime {flags} (format)``` - -## Flags - - - `--not-exact, -n`: the format string may be contained in the date (e.g. foo-2021-01-01-bar could match 2021-01-01) - -## Parameters - - - `format`: formatting date time string - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Converts string to datetime -```nu -> ["2021-12-30 00:00:00" "2021-12-31 00:00:00"] | dfr into-df | dfr as-datetime "%Y-%m-%d %H:%M:%S" -╭───┬─────────────╮ -│ # │ datetime │ -├───┼─────────────┤ -│ 0 │ 2 years ago │ -│ 1 │ 2 years ago │ -╰───┴─────────────╯ - -``` - -Converts string to datetime with high resolutions -```nu -> ["2021-12-30 00:00:00.123456789" "2021-12-31 00:00:00.123456789"] | dfr into-df | dfr as-datetime "%Y-%m-%d %H:%M:%S.%9f" -╭───┬─────────────╮ -│ # │ datetime │ -├───┼─────────────┤ -│ 0 │ 2 years ago │ -│ 1 │ 2 years ago │ -╰───┴─────────────╯ - -``` - -## Notes -Format example: - "%y/%m/%d %H:%M:%S" => 21/12/31 12:54:98 - "%y-%m-%d %H:%M:%S" => 2021-12-31 24:58:01 - "%y/%m/%d %H:%M:%S" => 21/12/31 24:58:01 - "%y%m%d %H:%M:%S" => 210319 23:58:50 - "%Y/%m/%d %H:%M:%S" => 2021/12/31 12:54:98 - "%Y-%m-%d %H:%M:%S" => 2021-12-31 24:58:01 - "%Y/%m/%d %H:%M:%S" => 2021/12/31 24:58:01 - "%Y%m%d %H:%M:%S" => 20210319 23:58:50 - "%FT%H:%M:%S" => 2019-04-18T02:45:55 - "%FT%H:%M:%S.%6f" => microseconds - "%FT%H:%M:%S.%9f" => nanoseconds \ No newline at end of file diff --git a/commands/docs/dfr_as.md b/commands/docs/dfr_as.md deleted file mode 100644 index c0e76c4218..0000000000 --- a/commands/docs/dfr_as.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr as -categories: | - expression -version: 0.93.0 -expression: | - Creates an alias expression. -usage: | - Creates an alias expression. -feature: dataframe ---- - - -# `dfr as` for [expression](/commands/categories/expression.md) - -
Creates an alias expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr as {flags} (Alias name)``` - -## Parameters - - - `Alias name`: Alias name for the expression - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates and alias expression -```nu -> dfr col a | dfr as new_a | dfr into-nu -╭───────┬────────────────────╮ -│ │ ╭───────┬────────╮ │ -│ expr │ │ expr │ column │ │ -│ │ │ value │ a │ │ -│ │ ╰───────┴────────╯ │ -│ alias │ new_a │ -╰───────┴────────────────────╯ -``` diff --git a/commands/docs/dfr_cache.md b/commands/docs/dfr_cache.md deleted file mode 100644 index 8e3049b47d..0000000000 --- a/commands/docs/dfr_cache.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: dfr cache -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Caches operations in a new LazyFrame. -usage: | - Caches operations in a new LazyFrame. -feature: dataframe ---- - - -# `dfr cache` for [lazyframe](/commands/categories/lazyframe.md) - -
Caches operations in a new LazyFrame.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr cache {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Caches the result into a new LazyFrame -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr reverse | dfr cache - -``` diff --git a/commands/docs/dfr_cast.md b/commands/docs/dfr_cast.md deleted file mode 100644 index ab4586946d..0000000000 --- a/commands/docs/dfr_cast.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: dfr cast -categories: | - dataframe -version: 0.93.0 -dataframe: | - Cast a column to a different dtype. -usage: | - Cast a column to a different dtype. -feature: dataframe ---- - - -# `dfr cast` for [dataframe](/commands/categories/dataframe.md) - -
Cast a column to a different dtype.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr cast {flags} (dtype) (column)``` - -## Parameters - - - `dtype`: The dtype to cast the column to - - `column`: The column to cast. Required when used with a dataframe. - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Cast a column in a dataframe to a different dtype -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr cast u8 a | dfr schema -╭───┬─────╮ -│ a │ u8 │ -│ b │ i64 │ -╰───┴─────╯ -``` - -Cast a column in a lazy dataframe to a different dtype -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr into-lazy | dfr cast u8 a | dfr schema -╭───┬─────╮ -│ a │ u8 │ -│ b │ i64 │ -╰───┴─────╯ -``` - -Cast a column in a expression to a different dtype -```nu -> [[a b]; [1 2] [1 4]] | dfr into-df | dfr group-by a | dfr agg [ (dfr col b | dfr cast u8 | dfr min | dfr as "b_min") ] | dfr schema - -``` diff --git a/commands/docs/dfr_col.md b/commands/docs/dfr_col.md deleted file mode 100644 index c0a7469904..0000000000 --- a/commands/docs/dfr_col.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr col -categories: | - expression -version: 0.93.0 -expression: | - Creates a named column expression. -usage: | - Creates a named column expression. -feature: dataframe ---- - - -# `dfr col` for [expression](/commands/categories/expression.md) - -
Creates a named column expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr col {flags} (column name)``` - -## Parameters - - - `column name`: Name of column to be used - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates a named column expression and converts it to a nu object -```nu -> dfr col a | dfr into-nu -╭───────┬────────╮ -│ expr │ column │ -│ value │ a │ -╰───────┴────────╯ -``` diff --git a/commands/docs/dfr_collect.md b/commands/docs/dfr_collect.md deleted file mode 100644 index bdfa499f92..0000000000 --- a/commands/docs/dfr_collect.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: dfr collect -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Collect lazy dataframe into eager dataframe. -usage: | - Collect lazy dataframe into eager dataframe. -feature: dataframe ---- - - -# `dfr collect` for [lazyframe](/commands/categories/lazyframe.md) - -
Collect lazy dataframe into eager dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr collect {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -drop duplicates -```nu -> [[a b]; [1 2] [3 4]] | dfr into-lazy | dfr collect -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_columns.md b/commands/docs/dfr_columns.md deleted file mode 100644 index 43c35a174e..0000000000 --- a/commands/docs/dfr_columns.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: dfr columns -categories: | - dataframe -version: 0.93.0 -dataframe: | - Show dataframe columns. -usage: | - Show dataframe columns. -feature: dataframe ---- - - -# `dfr columns` for [dataframe](/commands/categories/dataframe.md) - -
Show dataframe columns.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr columns {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Dataframe columns -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr columns -╭───┬───╮ -│ 0 │ a │ -│ 1 │ b │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_concat-str.md b/commands/docs/dfr_concat-str.md deleted file mode 100644 index a1ac492cf1..0000000000 --- a/commands/docs/dfr_concat-str.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr concat-str -categories: | - expression -version: 0.93.0 -expression: | - Creates a concat string expression. -usage: | - Creates a concat string expression. -feature: dataframe ---- - - -# `dfr concat-str` for [expression](/commands/categories/expression.md) - -
Creates a concat string expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr concat-str {flags} (separator) (concat expressions)``` - -## Parameters - - - `separator`: Separator used during the concatenation - - `concat expressions`: Expression(s) that define the string concatenation - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates a concat string expression -```nu -> let df = ([[a b c]; [one two 1] [three four 2]] | dfr into-df); - $df | dfr with-column ((dfr concat-str "-" [(dfr col a) (dfr col b) ((dfr col c) * 2)]) | dfr as concat) -╭───┬───────┬──────┬───┬──────────────╮ -│ # │ a │ b │ c │ concat │ -├───┼───────┼──────┼───┼──────────────┤ -│ 0 │ one │ two │ 1 │ one-two-2 │ -│ 1 │ three │ four │ 2 │ three-four-4 │ -╰───┴───────┴──────┴───┴──────────────╯ - -``` diff --git a/commands/docs/dfr_concatenate.md b/commands/docs/dfr_concatenate.md deleted file mode 100644 index 0bcb500ca3..0000000000 --- a/commands/docs/dfr_concatenate.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr concatenate -categories: | - dataframe -version: 0.93.0 -dataframe: | - Concatenates strings with other array. -usage: | - Concatenates strings with other array. -feature: dataframe ---- - - -# `dfr concatenate` for [dataframe](/commands/categories/dataframe.md) - -
Concatenates strings with other array.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr concatenate {flags} (other)``` - -## Parameters - - - `other`: Other array with string to be concatenated - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Concatenate string -```nu -> let other = ([za xs cd] | dfr into-df); - [abc abc abc] | dfr into-df | dfr concatenate $other -╭───┬───────╮ -│ # │ 0 │ -├───┼───────┤ -│ 0 │ abcza │ -│ 1 │ abcxs │ -│ 2 │ abccd │ -╰───┴───────╯ - -``` diff --git a/commands/docs/dfr_contains.md b/commands/docs/dfr_contains.md deleted file mode 100644 index f6648c349f..0000000000 --- a/commands/docs/dfr_contains.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: dfr contains -categories: | - dataframe -version: 0.93.0 -dataframe: | - Checks if a pattern is contained in a string. -usage: | - Checks if a pattern is contained in a string. -feature: dataframe ---- - - -# `dfr contains` for [dataframe](/commands/categories/dataframe.md) - -
Checks if a pattern is contained in a string.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr contains {flags} (pattern)``` - -## Parameters - - - `pattern`: Regex pattern to be searched - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns boolean indicating if pattern was found -```nu -> [abc acb acb] | dfr into-df | dfr contains ab -╭───┬───────╮ -│ # │ 0 │ -├───┼───────┤ -│ 0 │ true │ -│ 1 │ false │ -│ 2 │ false │ -╰───┴───────╯ - -``` diff --git a/commands/docs/dfr_count-null.md b/commands/docs/dfr_count-null.md deleted file mode 100644 index 2320579024..0000000000 --- a/commands/docs/dfr_count-null.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: dfr count-null -categories: | - dataframe -version: 0.93.0 -dataframe: | - Counts null values. -usage: | - Counts null values. -feature: dataframe ---- - - -# `dfr count-null` for [dataframe](/commands/categories/dataframe.md) - -
Counts null values.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr count-null {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Counts null values -```nu -> let s = ([1 1 0 0 3 3 4] | dfr into-df); - ($s / $s) | dfr count-null -╭───┬────────────╮ -│ # │ count_null │ -├───┼────────────┤ -│ 0 │ 2 │ -╰───┴────────────╯ - -``` diff --git a/commands/docs/dfr_count.md b/commands/docs/dfr_count.md deleted file mode 100644 index eaa3f7ce70..0000000000 --- a/commands/docs/dfr_count.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: dfr count -categories: | - expression -version: 0.93.0 -expression: | - Creates a count expression. -usage: | - Creates a count expression. -feature: dataframe ---- - - -# `dfr count` for [expression](/commands/categories/expression.md) - -
Creates a count expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr count {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - - -```nu -> - -``` diff --git a/commands/docs/dfr_cumulative.md b/commands/docs/dfr_cumulative.md deleted file mode 100644 index 06d8b69ada..0000000000 --- a/commands/docs/dfr_cumulative.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: dfr cumulative -categories: | - dataframe -version: 0.93.0 -dataframe: | - Cumulative calculation for a series. -usage: | - Cumulative calculation for a series. -feature: dataframe ---- - - -# `dfr cumulative` for [dataframe](/commands/categories/dataframe.md) - -
Cumulative calculation for a series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr cumulative {flags} (type)``` - -## Flags - - - `--reverse, -r`: Reverse cumulative calculation - -## Parameters - - - `type`: rolling operation - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Cumulative sum for a series -```nu -> [1 2 3 4 5] | dfr into-df | dfr cumulative sum -╭───┬──────────────────╮ -│ # │ 0_cumulative_sum │ -├───┼──────────────────┤ -│ 0 │ 1 │ -│ 1 │ 3 │ -│ 2 │ 6 │ -│ 3 │ 10 │ -│ 4 │ 15 │ -╰───┴──────────────────╯ - -``` diff --git a/commands/docs/dfr_datepart.md b/commands/docs/dfr_datepart.md deleted file mode 100644 index 30b00e2b9f..0000000000 --- a/commands/docs/dfr_datepart.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: dfr datepart -categories: | - expression -version: 0.93.0 -expression: | - Creates an expression for capturing the specified datepart in a column. -usage: | - Creates an expression for capturing the specified datepart in a column. -feature: dataframe ---- - - -# `dfr datepart` for [expression](/commands/categories/expression.md) - -
Creates an expression for capturing the specified datepart in a column.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr datepart {flags} (Datepart name)``` - -## Parameters - - - `Datepart name`: Part of the date to capture. Possible values are year, quarter, month, week, weekday, day, hour, minute, second, millisecond, microsecond, nanosecond - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates an expression to capture the year date part -```nu -> [["2021-12-30T01:02:03.123456789"]] | dfr into-df | dfr as-datetime "%Y-%m-%dT%H:%M:%S.%9f" | dfr with-column [(dfr col datetime | dfr datepart year | dfr as datetime_year )] -╭───┬─────────────┬───────────────╮ -│ # │ datetime │ datetime_year │ -├───┼─────────────┼───────────────┤ -│ 0 │ 2 years ago │ 2021 │ -╰───┴─────────────┴───────────────╯ - -``` - -Creates an expression to capture multiple date parts -```nu -> [["2021-12-30T01:02:03.123456789"]] | dfr into-df | dfr as-datetime "%Y-%m-%dT%H:%M:%S.%9f" | - dfr with-column [ (dfr col datetime | dfr datepart year | dfr as datetime_year ), - (dfr col datetime | dfr datepart month | dfr as datetime_month ), - (dfr col datetime | dfr datepart day | dfr as datetime_day ), - (dfr col datetime | dfr datepart hour | dfr as datetime_hour ), - (dfr col datetime | dfr datepart minute | dfr as datetime_minute ), - (dfr col datetime | dfr datepart second | dfr as datetime_second ), - (dfr col datetime | dfr datepart nanosecond | dfr as datetime_ns ) ] -╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮ -│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │ -├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤ -│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │ -╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯ - -``` diff --git a/commands/docs/dfr_drop-duplicates.md b/commands/docs/dfr_drop-duplicates.md deleted file mode 100644 index 8682e64d9b..0000000000 --- a/commands/docs/dfr_drop-duplicates.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: dfr drop-duplicates -categories: | - dataframe -version: 0.93.0 -dataframe: | - Drops duplicate values in dataframe. -usage: | - Drops duplicate values in dataframe. -feature: dataframe ---- - - -# `dfr drop-duplicates` for [dataframe](/commands/categories/dataframe.md) - -
Drops duplicate values in dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr drop-duplicates {flags} (subset)``` - -## Flags - - - `--maintain, -m`: maintain order - - `--last, -l`: keeps last duplicate value (by default keeps first) - -## Parameters - - - `subset`: subset of columns to drop duplicates - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -drop duplicates -```nu -> [[a b]; [1 2] [3 4] [1 2]] | dfr into-df | dfr drop-duplicates -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 3 │ 4 │ -│ 1 │ 1 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_drop-nulls.md b/commands/docs/dfr_drop-nulls.md deleted file mode 100644 index dfc5e19a16..0000000000 --- a/commands/docs/dfr_drop-nulls.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: dfr drop-nulls -categories: | - dataframe -version: 0.93.0 -dataframe: | - Drops null values in dataframe. -usage: | - Drops null values in dataframe. -feature: dataframe ---- - - -# `dfr drop-nulls` for [dataframe](/commands/categories/dataframe.md) - -
Drops null values in dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr drop-nulls {flags} (subset)``` - -## Parameters - - - `subset`: subset of columns to drop nulls - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -drop null values in dataframe -```nu -> let df = ([[a b]; [1 2] [3 0] [1 2]] | dfr into-df); - let res = ($df.b / $df.b); - let a = ($df | dfr with-column $res --name res); - $a | dfr drop-nulls -╭───┬───┬───┬─────╮ -│ # │ a │ b │ res │ -├───┼───┼───┼─────┤ -│ 0 │ 1 │ 2 │ 1 │ -│ 1 │ 1 │ 2 │ 1 │ -╰───┴───┴───┴─────╯ - -``` - -drop null values in dataframe -```nu -> let s = ([1 2 0 0 3 4] | dfr into-df); - ($s / $s) | dfr drop-nulls -╭───┬─────────╮ -│ # │ div_0_0 │ -├───┼─────────┤ -│ 0 │ 1 │ -│ 1 │ 1 │ -│ 2 │ 1 │ -│ 3 │ 1 │ -╰───┴─────────╯ - -``` diff --git a/commands/docs/dfr_drop.md b/commands/docs/dfr_drop.md deleted file mode 100644 index 119e8f5a37..0000000000 --- a/commands/docs/dfr_drop.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr drop -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates a new dataframe by dropping the selected columns. -usage: | - Creates a new dataframe by dropping the selected columns. -feature: dataframe ---- - - -# `dfr drop` for [dataframe](/commands/categories/dataframe.md) - -
Creates a new dataframe by dropping the selected columns.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr drop {flags} ...rest``` - -## Parameters - - - `...rest`: column names to be dropped - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -drop column a -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr drop a -╭───┬───╮ -│ # │ b │ -├───┼───┤ -│ 0 │ 2 │ -│ 1 │ 4 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_dtypes.md b/commands/docs/dfr_dtypes.md deleted file mode 100644 index 099be2d82f..0000000000 --- a/commands/docs/dfr_dtypes.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: dfr dtypes -categories: | - dataframe -version: 0.93.0 -dataframe: | - Show dataframe data types. -usage: | - Show dataframe data types. -feature: dataframe ---- - - -# `dfr dtypes` for [dataframe](/commands/categories/dataframe.md) - -
Show dataframe data types.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr dtypes {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Dataframe dtypes -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr dtypes -╭───┬────────┬───────╮ -│ # │ column │ dtype │ -├───┼────────┼───────┤ -│ 0 │ a │ i64 │ -│ 1 │ b │ i64 │ -╰───┴────────┴───────╯ - -``` diff --git a/commands/docs/dfr_dummies.md b/commands/docs/dfr_dummies.md deleted file mode 100644 index b2b4f3d8cd..0000000000 --- a/commands/docs/dfr_dummies.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: dfr dummies -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates a new dataframe with dummy variables. -usage: | - Creates a new dataframe with dummy variables. -feature: dataframe ---- - - -# `dfr dummies` for [dataframe](/commands/categories/dataframe.md) - -
Creates a new dataframe with dummy variables.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr dummies {flags} ``` - -## Flags - - - `--drop-first, -d`: Drop first row - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create new dataframe with dummy variables from a dataframe -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr dummies -╭───┬─────┬─────┬─────┬─────╮ -│ # │ a_1 │ a_3 │ b_2 │ b_4 │ -├───┼─────┼─────┼─────┼─────┤ -│ 0 │ 1 │ 0 │ 1 │ 0 │ -│ 1 │ 0 │ 1 │ 0 │ 1 │ -╰───┴─────┴─────┴─────┴─────╯ - -``` - -Create new dataframe with dummy variables from a series -```nu -> [1 2 2 3 3] | dfr into-df | dfr dummies -╭───┬─────┬─────┬─────╮ -│ # │ 0_1 │ 0_2 │ 0_3 │ -├───┼─────┼─────┼─────┤ -│ 0 │ 1 │ 0 │ 0 │ -│ 1 │ 0 │ 1 │ 0 │ -│ 2 │ 0 │ 1 │ 0 │ -│ 3 │ 0 │ 0 │ 1 │ -│ 4 │ 0 │ 0 │ 1 │ -╰───┴─────┴─────┴─────╯ - -``` diff --git a/commands/docs/dfr_explode.md b/commands/docs/dfr_explode.md deleted file mode 100644 index 21441d1500..0000000000 --- a/commands/docs/dfr_explode.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: dfr explode -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Explodes a dataframe or creates a explode expression. -usage: | - Explodes a dataframe or creates a explode expression. -feature: dataframe ---- - - -# `dfr explode` for [lazyframe](/commands/categories/lazyframe.md) - -
Explodes a dataframe or creates a explode expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr explode {flags} ...rest``` - -## Parameters - - - `...rest`: columns to explode, only applicable for dataframes - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Explode the specified dataframe -```nu -> [[id name hobbies]; [1 Mercy [Cycling Knitting]] [2 Bob [Skiing Football]]] | dfr into-df | dfr explode hobbies | dfr collect -╭───┬────┬───────┬──────────╮ -│ # │ id │ name │ hobbies │ -├───┼────┼───────┼──────────┤ -│ 0 │ 1 │ Mercy │ Cycling │ -│ 1 │ 1 │ Mercy │ Knitting │ -│ 2 │ 2 │ Bob │ Skiing │ -│ 3 │ 2 │ Bob │ Football │ -╰───┴────┴───────┴──────────╯ - -``` - -Select a column and explode the values -```nu -> [[id name hobbies]; [1 Mercy [Cycling Knitting]] [2 Bob [Skiing Football]]] | dfr into-df | dfr select (dfr col hobbies | dfr explode) -╭───┬──────────╮ -│ # │ hobbies │ -├───┼──────────┤ -│ 0 │ Cycling │ -│ 1 │ Knitting │ -│ 2 │ Skiing │ -│ 3 │ Football │ -╰───┴──────────╯ - -``` diff --git a/commands/docs/dfr_expr-not.md b/commands/docs/dfr_expr-not.md deleted file mode 100644 index 183e49f892..0000000000 --- a/commands/docs/dfr_expr-not.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: dfr expr-not -categories: | - expression -version: 0.93.0 -expression: | - Creates a not expression. -usage: | - Creates a not expression. -feature: dataframe ---- - - -# `dfr expr-not` for [expression](/commands/categories/expression.md) - -
Creates a not expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr expr-not {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates a not expression -```nu -> (dfr col a) > 2) | dfr expr-not - -``` diff --git a/commands/docs/dfr_fetch.md b/commands/docs/dfr_fetch.md deleted file mode 100644 index 25a5da0327..0000000000 --- a/commands/docs/dfr_fetch.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr fetch -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Collects the lazyframe to the selected rows. -usage: | - Collects the lazyframe to the selected rows. -feature: dataframe ---- - - -# `dfr fetch` for [lazyframe](/commands/categories/lazyframe.md) - -
Collects the lazyframe to the selected rows.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr fetch {flags} (rows)``` - -## Parameters - - - `rows`: number of rows to be fetched from lazyframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Fetch a rows from the dataframe -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr fetch 2 -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 6 │ 2 │ -│ 1 │ 4 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_fill-nan.md b/commands/docs/dfr_fill-nan.md deleted file mode 100644 index c58b27d00c..0000000000 --- a/commands/docs/dfr_fill-nan.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: dfr fill-nan -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Replaces NaN values with the given expression. -usage: | - Replaces NaN values with the given expression. -feature: dataframe ---- - - -# `dfr fill-nan` for [lazyframe](/commands/categories/lazyframe.md) - -
Replaces NaN values with the given expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr fill-nan {flags} (fill)``` - -## Parameters - - - `fill`: Expression to use to fill the NAN values - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Fills the NaN values with 0 -```nu -> [1 2 NaN 3 NaN] | dfr into-df | dfr fill-nan 0 -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 1 │ -│ 1 │ 2 │ -│ 2 │ 0 │ -│ 3 │ 3 │ -│ 4 │ 0 │ -╰───┴───╯ - -``` - -Fills the NaN values of a whole dataframe -```nu -> [[a b]; [0.2 1] [0.1 NaN]] | dfr into-df | dfr fill-nan 0 -╭───┬──────┬───╮ -│ # │ a │ b │ -├───┼──────┼───┤ -│ 0 │ 0.20 │ 1 │ -│ 1 │ 0.10 │ 0 │ -╰───┴──────┴───╯ - -``` diff --git a/commands/docs/dfr_fill-null.md b/commands/docs/dfr_fill-null.md deleted file mode 100644 index f711be93e3..0000000000 --- a/commands/docs/dfr_fill-null.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: dfr fill-null -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Replaces NULL values with the given expression. -usage: | - Replaces NULL values with the given expression. -feature: dataframe ---- - - -# `dfr fill-null` for [lazyframe](/commands/categories/lazyframe.md) - -
Replaces NULL values with the given expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr fill-null {flags} (fill)``` - -## Parameters - - - `fill`: Expression to use to fill the null values - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Fills the null values by 0 -```nu -> [1 2 2 3 3] | dfr into-df | dfr shift 2 | dfr fill-null 0 -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 0 │ -│ 1 │ 0 │ -│ 2 │ 1 │ -│ 3 │ 2 │ -│ 4 │ 2 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_filter-with.md b/commands/docs/dfr_filter-with.md deleted file mode 100644 index 329a4ffccb..0000000000 --- a/commands/docs/dfr_filter-with.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: dfr filter-with -categories: | - dataframe or lazyframe -version: 0.93.0 -dataframe_or_lazyframe: | - Filters dataframe using a mask or expression as reference. -usage: | - Filters dataframe using a mask or expression as reference. -feature: dataframe ---- - - -# `dfr filter-with` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) - -
Filters dataframe using a mask or expression as reference.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr filter-with {flags} (mask or expression)``` - -## Parameters - - - `mask or expression`: boolean mask used to filter data - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Filter dataframe using a bool mask -```nu -> let mask = ([true false] | dfr into-df); - [[a b]; [1 2] [3 4]] | dfr into-df | dfr filter-with $mask -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -╰───┴───┴───╯ - -``` - -Filter dataframe using an expression -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr filter-with ((dfr col a) > 1) -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_filter.md b/commands/docs/dfr_filter.md deleted file mode 100644 index f1401e617d..0000000000 --- a/commands/docs/dfr_filter.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr filter -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Filter dataframe based in expression. -usage: | - Filter dataframe based in expression. -feature: dataframe ---- - - -# `dfr filter` for [lazyframe](/commands/categories/lazyframe.md) - -
Filter dataframe based in expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr filter {flags} (filter expression)``` - -## Parameters - - - `filter expression`: Expression that define the column selection - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Filter dataframe using an expression -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr filter ((dfr col a) >= 4) -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 6 │ 2 │ -│ 1 │ 4 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_first.md b/commands/docs/dfr_first.md deleted file mode 100644 index 7878ded139..0000000000 --- a/commands/docs/dfr_first.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: dfr first -categories: | - dataframe -version: 0.93.0 -dataframe: | - Show only the first number of rows or create a first expression -usage: | - Show only the first number of rows or create a first expression -feature: dataframe ---- - - -# `dfr first` for [dataframe](/commands/categories/dataframe.md) - -
Show only the first number of rows or create a first expression
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr first {flags} (rows)``` - -## Parameters - - - `rows`: starting from the front, the number of rows to return - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Return the first row of a dataframe -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr first -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -╰───┴───┴───╯ - -``` - -Return the first two rows of a dataframe -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr first 2 -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` - -Creates a first expression from a column -```nu -> dfr col a | dfr first - -``` diff --git a/commands/docs/dfr_flatten.md b/commands/docs/dfr_flatten.md deleted file mode 100644 index 0d2faa8a5e..0000000000 --- a/commands/docs/dfr_flatten.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: dfr flatten -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - An alias for dfr explode. -usage: | - An alias for dfr explode. -feature: dataframe ---- - - -# `dfr flatten` for [lazyframe](/commands/categories/lazyframe.md) - -
An alias for dfr explode.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr flatten {flags} ...rest``` - -## Parameters - - - `...rest`: columns to flatten, only applicable for dataframes - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Flatten the specified dataframe -```nu -> [[id name hobbies]; [1 Mercy [Cycling Knitting]] [2 Bob [Skiing Football]]] | dfr into-df | dfr flatten hobbies | dfr collect -╭───┬────┬───────┬──────────╮ -│ # │ id │ name │ hobbies │ -├───┼────┼───────┼──────────┤ -│ 0 │ 1 │ Mercy │ Cycling │ -│ 1 │ 1 │ Mercy │ Knitting │ -│ 2 │ 2 │ Bob │ Skiing │ -│ 3 │ 2 │ Bob │ Football │ -╰───┴────┴───────┴──────────╯ - -``` - -Select a column and flatten the values -```nu -> [[id name hobbies]; [1 Mercy [Cycling Knitting]] [2 Bob [Skiing Football]]] | dfr into-df | dfr select (dfr col hobbies | dfr flatten) -╭───┬──────────╮ -│ # │ hobbies │ -├───┼──────────┤ -│ 0 │ Cycling │ -│ 1 │ Knitting │ -│ 2 │ Skiing │ -│ 3 │ Football │ -╰───┴──────────╯ - -``` diff --git a/commands/docs/dfr_get-day.md b/commands/docs/dfr_get-day.md deleted file mode 100644 index 4fe5df5dee..0000000000 --- a/commands/docs/dfr_get-day.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-day -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets day from date. -usage: | - Gets day from date. -feature: dataframe ---- - - -# `dfr get-day` for [dataframe](/commands/categories/dataframe.md) - -
Gets day from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-day {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns day from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-day -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 4 │ -│ 1 │ 4 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_get-hour.md b/commands/docs/dfr_get-hour.md deleted file mode 100644 index 4345fc7d3e..0000000000 --- a/commands/docs/dfr_get-hour.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-hour -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets hour from date. -usage: | - Gets hour from date. -feature: dataframe ---- - - -# `dfr get-hour` for [dataframe](/commands/categories/dataframe.md) - -
Gets hour from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-hour {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns hour from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-hour -╭───┬────╮ -│ # │ 0 │ -├───┼────┤ -│ 0 │ 16 │ -│ 1 │ 16 │ -╰───┴────╯ - -``` diff --git a/commands/docs/dfr_get-minute.md b/commands/docs/dfr_get-minute.md deleted file mode 100644 index 7a1ee91d71..0000000000 --- a/commands/docs/dfr_get-minute.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-minute -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets minute from date. -usage: | - Gets minute from date. -feature: dataframe ---- - - -# `dfr get-minute` for [dataframe](/commands/categories/dataframe.md) - -
Gets minute from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-minute {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns minute from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-minute -╭───┬────╮ -│ # │ 0 │ -├───┼────┤ -│ 0 │ 39 │ -│ 1 │ 39 │ -╰───┴────╯ - -``` diff --git a/commands/docs/dfr_get-month.md b/commands/docs/dfr_get-month.md deleted file mode 100644 index 2975f76706..0000000000 --- a/commands/docs/dfr_get-month.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-month -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets month from date. -usage: | - Gets month from date. -feature: dataframe ---- - - -# `dfr get-month` for [dataframe](/commands/categories/dataframe.md) - -
Gets month from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-month {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns month from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-month -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 8 │ -│ 1 │ 8 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_get-nanosecond.md b/commands/docs/dfr_get-nanosecond.md deleted file mode 100644 index 4cc2887a3a..0000000000 --- a/commands/docs/dfr_get-nanosecond.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-nanosecond -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets nanosecond from date. -usage: | - Gets nanosecond from date. -feature: dataframe ---- - - -# `dfr get-nanosecond` for [dataframe](/commands/categories/dataframe.md) - -
Gets nanosecond from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-nanosecond {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns nanosecond from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-nanosecond -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 0 │ -│ 1 │ 0 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_get-ordinal.md b/commands/docs/dfr_get-ordinal.md deleted file mode 100644 index 50f4fb7e9f..0000000000 --- a/commands/docs/dfr_get-ordinal.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-ordinal -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets ordinal from date. -usage: | - Gets ordinal from date. -feature: dataframe ---- - - -# `dfr get-ordinal` for [dataframe](/commands/categories/dataframe.md) - -
Gets ordinal from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-ordinal {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns ordinal from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-ordinal -╭───┬─────╮ -│ # │ 0 │ -├───┼─────┤ -│ 0 │ 217 │ -│ 1 │ 217 │ -╰───┴─────╯ - -``` diff --git a/commands/docs/dfr_get-second.md b/commands/docs/dfr_get-second.md deleted file mode 100644 index 719c5d87d5..0000000000 --- a/commands/docs/dfr_get-second.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-second -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets second from date. -usage: | - Gets second from date. -feature: dataframe ---- - - -# `dfr get-second` for [dataframe](/commands/categories/dataframe.md) - -
Gets second from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-second {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns second from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-second -╭───┬────╮ -│ # │ 0 │ -├───┼────┤ -│ 0 │ 18 │ -│ 1 │ 18 │ -╰───┴────╯ - -``` diff --git a/commands/docs/dfr_get-week.md b/commands/docs/dfr_get-week.md deleted file mode 100644 index 650e0701b3..0000000000 --- a/commands/docs/dfr_get-week.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-week -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets week from date. -usage: | - Gets week from date. -feature: dataframe ---- - - -# `dfr get-week` for [dataframe](/commands/categories/dataframe.md) - -
Gets week from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-week {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns week from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-week -╭───┬────╮ -│ # │ 0 │ -├───┼────┤ -│ 0 │ 32 │ -│ 1 │ 32 │ -╰───┴────╯ - -``` diff --git a/commands/docs/dfr_get-weekday.md b/commands/docs/dfr_get-weekday.md deleted file mode 100644 index 8ca50638d8..0000000000 --- a/commands/docs/dfr_get-weekday.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-weekday -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets weekday from date. -usage: | - Gets weekday from date. -feature: dataframe ---- - - -# `dfr get-weekday` for [dataframe](/commands/categories/dataframe.md) - -
Gets weekday from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-weekday {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns weekday from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-weekday -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 2 │ -│ 1 │ 2 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_get-year.md b/commands/docs/dfr_get-year.md deleted file mode 100644 index bc0c7da25b..0000000000 --- a/commands/docs/dfr_get-year.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr get-year -categories: | - dataframe -version: 0.93.0 -dataframe: | - Gets year from date. -usage: | - Gets year from date. -feature: dataframe ---- - - -# `dfr get-year` for [dataframe](/commands/categories/dataframe.md) - -
Gets year from date.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get-year {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns year from a date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr get-year -╭───┬──────╮ -│ # │ 0 │ -├───┼──────┤ -│ 0 │ 2020 │ -│ 1 │ 2020 │ -╰───┴──────╯ - -``` diff --git a/commands/docs/dfr_get.md b/commands/docs/dfr_get.md deleted file mode 100644 index 640b725450..0000000000 --- a/commands/docs/dfr_get.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr get -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates dataframe with the selected columns. -usage: | - Creates dataframe with the selected columns. -feature: dataframe ---- - - -# `dfr get` for [dataframe](/commands/categories/dataframe.md) - -
Creates dataframe with the selected columns.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr get {flags} ...rest``` - -## Parameters - - - `...rest`: column names to sort dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns the selected column -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr get a -╭───┬───╮ -│ # │ a │ -├───┼───┤ -│ 0 │ 1 │ -│ 1 │ 3 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_group-by.md b/commands/docs/dfr_group-by.md deleted file mode 100644 index f2b5926d41..0000000000 --- a/commands/docs/dfr_group-by.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: dfr group-by -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Creates a group-by object that can be used for other aggregations. -usage: | - Creates a group-by object that can be used for other aggregations. -feature: dataframe ---- - - -# `dfr group-by` for [lazyframe](/commands/categories/lazyframe.md) - -
Creates a group-by object that can be used for other aggregations.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr group-by {flags} ...rest``` - -## Parameters - - - `...rest`: Expression(s) that define the lazy group-by - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Group by and perform an aggregation -```nu -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr into-df - | dfr group-by a - | dfr agg [ - (dfr col b | dfr min | dfr as "b_min") - (dfr col b | dfr max | dfr as "b_max") - (dfr col b | dfr sum | dfr as "b_sum") - ] -╭───┬───┬───────┬───────┬───────╮ -│ # │ a │ b_min │ b_max │ b_sum │ -├───┼───┼───────┼───────┼───────┤ -│ 0 │ 1 │ 2 │ 4 │ 6 │ -│ 1 │ 2 │ 4 │ 6 │ 10 │ -╰───┴───┴───────┴───────┴───────╯ - -``` - -Group by and perform an aggregation -```nu -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr into-lazy - | dfr group-by a - | dfr agg [ - (dfr col b | dfr min | dfr as "b_min") - (dfr col b | dfr max | dfr as "b_max") - (dfr col b | dfr sum | dfr as "b_sum") - ] - | dfr collect -╭───┬───┬───────┬───────┬───────╮ -│ # │ a │ b_min │ b_max │ b_sum │ -├───┼───┼───────┼───────┼───────┤ -│ 0 │ 1 │ 2 │ 4 │ 6 │ -│ 1 │ 2 │ 4 │ 6 │ 10 │ -╰───┴───┴───────┴───────┴───────╯ - -``` diff --git a/commands/docs/dfr_implode.md b/commands/docs/dfr_implode.md deleted file mode 100644 index 4e6e61b418..0000000000 --- a/commands/docs/dfr_implode.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: dfr implode -categories: | - expression -version: 0.93.0 -expression: | - Aggregates a group to a Series. -usage: | - Aggregates a group to a Series. -feature: dataframe ---- - - -# `dfr implode` for [expression](/commands/categories/expression.md) - -
Aggregates a group to a Series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr implode {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - - -```nu -> - -``` diff --git a/commands/docs/dfr_into-df.md b/commands/docs/dfr_into-df.md deleted file mode 100644 index 1cbd8cb5f2..0000000000 --- a/commands/docs/dfr_into-df.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: dfr into-df -categories: | - dataframe -version: 0.93.0 -dataframe: | - Converts a list, table or record into a dataframe. -usage: | - Converts a list, table or record into a dataframe. -feature: dataframe ---- - - -# `dfr into-df` for [dataframe](/commands/categories/dataframe.md) - -
Converts a list, table or record into a dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr into-df {flags} ``` - -## Flags - - - `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Takes a dictionary and creates a dataframe -```nu -> [[a b];[1 2] [3 4]] | dfr into-df -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` - -Takes a list of tables and creates a dataframe -```nu -> [[1 2 a] [3 4 b] [5 6 c]] | dfr into-df -╭───┬───┬───┬───╮ -│ # │ 0 │ 1 │ 2 │ -├───┼───┼───┼───┤ -│ 0 │ 1 │ 2 │ a │ -│ 1 │ 3 │ 4 │ b │ -│ 2 │ 5 │ 6 │ c │ -╰───┴───┴───┴───╯ - -``` - -Takes a list and creates a dataframe -```nu -> [a b c] | dfr into-df -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ a │ -│ 1 │ b │ -│ 2 │ c │ -╰───┴───╯ - -``` - -Takes a list of booleans and creates a dataframe -```nu -> [true true false] | dfr into-df -╭───┬───────╮ -│ # │ 0 │ -├───┼───────┤ -│ 0 │ true │ -│ 1 │ true │ -│ 2 │ false │ -╰───┴───────╯ - -``` - -Convert to a dataframe and provide a schema -```nu -> {a: 1, b: {a: [1 2 3]}, c: [a b c]}| dfr into-df -s {a: u8, b: {a: list}, c: list} -╭───┬───┬───────────────────┬───────────╮ -│ # │ a │ b │ c │ -├───┼───┼───────────────────┼───────────┤ -│ 0 │ 1 │ ╭───┬───────────╮ │ ╭───┬───╮ │ -│ │ │ │ │ ╭───┬───╮ │ │ │ 0 │ a │ │ -│ │ │ │ a │ │ 0 │ 1 │ │ │ │ 1 │ b │ │ -│ │ │ │ │ │ 1 │ 2 │ │ │ │ 2 │ c │ │ -│ │ │ │ │ │ 2 │ 3 │ │ │ ╰───┴───╯ │ -│ │ │ │ │ ╰───┴───╯ │ │ │ -│ │ │ ╰───┴───────────╯ │ │ -╰───┴───┴───────────────────┴───────────╯ - -``` - -Convert to a dataframe and provide a schema that adds a new column -```nu -> [[a b]; [1 "foo"] [2 "bar"]] | dfr into-df -s {a: u8, b:str, c:i64} | dfr fill-null 3 -╭───┬───┬─────┬───╮ -│ # │ a │ b │ c │ -├───┼───┼─────┼───┤ -│ 0 │ 1 │ foo │ 3 │ -│ 1 │ 2 │ bar │ 3 │ -╰───┴───┴─────┴───╯ - -``` diff --git a/commands/docs/dfr_into-lazy.md b/commands/docs/dfr_into-lazy.md deleted file mode 100644 index de7dc27010..0000000000 --- a/commands/docs/dfr_into-lazy.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: dfr into-lazy -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Converts a dataframe into a lazy dataframe. -usage: | - Converts a dataframe into a lazy dataframe. -feature: dataframe ---- - - -# `dfr into-lazy` for [lazyframe](/commands/categories/lazyframe.md) - -
Converts a dataframe into a lazy dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr into-lazy {flags} ``` - -## Flags - - - `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Takes a dictionary and creates a lazy dataframe -```nu -> [[a b];[1 2] [3 4]] | dfr into-lazy - -``` diff --git a/commands/docs/dfr_into-nu.md b/commands/docs/dfr_into-nu.md deleted file mode 100644 index c221c528f1..0000000000 --- a/commands/docs/dfr_into-nu.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: dfr into-nu -categories: | - dataframe -version: 0.93.0 -dataframe: | - Converts a dataframe or an expression into into nushell value for access and exploration. -usage: | - Converts a dataframe or an expression into into nushell value for access and exploration. -feature: dataframe ---- - - -# `dfr into-nu` for [dataframe](/commands/categories/dataframe.md) - -
Converts a dataframe or an expression into into nushell value for access and exploration.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr into-nu {flags} ``` - -## Flags - - - `--rows, -n {number}`: number of rows to be shown - - `--tail, -t`: shows tail rows - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Shows head rows from dataframe -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr into-nu -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` - -Shows tail rows from dataframe -```nu -> [[a b]; [1 2] [5 6] [3 4]] | dfr into-df | dfr into-nu --tail --rows 1 -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 2 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` - -Convert a col expression into a nushell value -```nu -> dfr col a | dfr into-nu -╭───────┬────────╮ -│ expr │ column │ -│ value │ a │ -╰───────┴────────╯ -``` diff --git a/commands/docs/dfr_is-duplicated.md b/commands/docs/dfr_is-duplicated.md deleted file mode 100644 index f287cab667..0000000000 --- a/commands/docs/dfr_is-duplicated.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: dfr is-duplicated -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates mask indicating duplicated values. -usage: | - Creates mask indicating duplicated values. -feature: dataframe ---- - - -# `dfr is-duplicated` for [dataframe](/commands/categories/dataframe.md) - -
Creates mask indicating duplicated values.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr is-duplicated {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create mask indicating duplicated values -```nu -> [5 6 6 6 8 8 8] | dfr into-df | dfr is-duplicated -╭───┬───────────────╮ -│ # │ is_duplicated │ -├───┼───────────────┤ -│ 0 │ false │ -│ 1 │ true │ -│ 2 │ true │ -│ 3 │ true │ -│ 4 │ true │ -│ 5 │ true │ -│ 6 │ true │ -╰───┴───────────────╯ - -``` - -Create mask indicating duplicated rows in a dataframe -```nu -> [[a, b]; [1 2] [1 2] [3 3] [3 3] [1 1]] | dfr into-df | dfr is-duplicated -╭───┬───────────────╮ -│ # │ is_duplicated │ -├───┼───────────────┤ -│ 0 │ true │ -│ 1 │ true │ -│ 2 │ true │ -│ 3 │ true │ -│ 4 │ false │ -╰───┴───────────────╯ - -``` diff --git a/commands/docs/dfr_is-in.md b/commands/docs/dfr_is-in.md deleted file mode 100644 index dd38e6e703..0000000000 --- a/commands/docs/dfr_is-in.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr is-in -categories: | - expression -version: 0.93.0 -expression: | - Creates an is-in expression. -usage: | - Creates an is-in expression. -feature: dataframe ---- - - -# `dfr is-in` for [expression](/commands/categories/expression.md) - -
Creates an is-in expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr is-in {flags} (list)``` - -## Parameters - - - `list`: List to check if values are in - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates a is-in expression -```nu -> let df = ([[a b]; [one 1] [two 2] [three 3]] | dfr into-df); - $df | dfr with-column (dfr col a | dfr is-in [one two] | dfr as a_in) -╭───┬───────┬───┬───────╮ -│ # │ a │ b │ a_in │ -├───┼───────┼───┼───────┤ -│ 0 │ one │ 1 │ true │ -│ 1 │ two │ 2 │ true │ -│ 2 │ three │ 3 │ false │ -╰───┴───────┴───┴───────╯ - -``` diff --git a/commands/docs/dfr_is-not-null.md b/commands/docs/dfr_is-not-null.md deleted file mode 100644 index c59ba051ae..0000000000 --- a/commands/docs/dfr_is-not-null.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: dfr is-not-null -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates mask where value is not null. -usage: | - Creates mask where value is not null. -feature: dataframe ---- - - -# `dfr is-not-null` for [dataframe](/commands/categories/dataframe.md) - -
Creates mask where value is not null.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr is-not-null {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create mask where values are not null -```nu -> let s = ([5 6 0 8] | dfr into-df); - let res = ($s / $s); - $res | dfr is-not-null -╭───┬─────────────╮ -│ # │ is_not_null │ -├───┼─────────────┤ -│ 0 │ true │ -│ 1 │ true │ -│ 2 │ false │ -│ 3 │ true │ -╰───┴─────────────╯ - -``` - -Creates a is not null expression from a column -```nu -> dfr col a | dfr is-not-null - -``` diff --git a/commands/docs/dfr_is-null.md b/commands/docs/dfr_is-null.md deleted file mode 100644 index 74d43ea5aa..0000000000 --- a/commands/docs/dfr_is-null.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: dfr is-null -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates mask where value is null. -usage: | - Creates mask where value is null. -feature: dataframe ---- - - -# `dfr is-null` for [dataframe](/commands/categories/dataframe.md) - -
Creates mask where value is null.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr is-null {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create mask where values are null -```nu -> let s = ([5 6 0 8] | dfr into-df); - let res = ($s / $s); - $res | dfr is-null -╭───┬─────────╮ -│ # │ is_null │ -├───┼─────────┤ -│ 0 │ false │ -│ 1 │ false │ -│ 2 │ true │ -│ 3 │ false │ -╰───┴─────────╯ - -``` - -Creates a is null expression from a column -```nu -> dfr col a | dfr is-null - -``` diff --git a/commands/docs/dfr_is-unique.md b/commands/docs/dfr_is-unique.md deleted file mode 100644 index 1ef37c16c9..0000000000 --- a/commands/docs/dfr_is-unique.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: dfr is-unique -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates mask indicating unique values. -usage: | - Creates mask indicating unique values. -feature: dataframe ---- - - -# `dfr is-unique` for [dataframe](/commands/categories/dataframe.md) - -
Creates mask indicating unique values.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr is-unique {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create mask indicating unique values -```nu -> [5 6 6 6 8 8 8] | dfr into-df | dfr is-unique -╭───┬───────────╮ -│ # │ is_unique │ -├───┼───────────┤ -│ 0 │ true │ -│ 1 │ false │ -│ 2 │ false │ -│ 3 │ false │ -│ 4 │ false │ -│ 5 │ false │ -│ 6 │ false │ -╰───┴───────────╯ - -``` - -Create mask indicating duplicated rows in a dataframe -```nu -> [[a, b]; [1 2] [1 2] [3 3] [3 3] [1 1]] | dfr into-df | dfr is-unique -╭───┬───────────╮ -│ # │ is_unique │ -├───┼───────────┤ -│ 0 │ false │ -│ 1 │ false │ -│ 2 │ false │ -│ 3 │ false │ -│ 4 │ true │ -╰───┴───────────╯ - -``` diff --git a/commands/docs/dfr_join.md b/commands/docs/dfr_join.md deleted file mode 100644 index be192018a3..0000000000 --- a/commands/docs/dfr_join.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: dfr join -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Joins a lazy frame with other lazy frame. -usage: | - Joins a lazy frame with other lazy frame. -feature: dataframe ---- - - -# `dfr join` for [lazyframe](/commands/categories/lazyframe.md) - -
Joins a lazy frame with other lazy frame.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr join {flags} (other) (left_on) (right_on)``` - -## Flags - - - `--inner, -i`: inner join between lazyframes (default) - - `--left, -l`: left join between lazyframes - - `--outer, -o`: outer join between lazyframes - - `--cross, -c`: cross join between lazyframes - - `--suffix, -s {string}`: Suffix to use on columns with same name - -## Parameters - - - `other`: LazyFrame to join with - - `left_on`: Left column(s) to join on - - `right_on`: Right column(s) to join on - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Join two lazy dataframes -```nu -> let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | dfr into-lazy); - let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [2 "c" "var"] [3 "c" "const"]] | dfr into-lazy); - $df_a | dfr join $df_b a foo | dfr collect -╭───┬───┬───┬───┬─────┬─────╮ -│ # │ a │ b │ c │ bar │ ham │ -├───┼───┼───┼───┼─────┼─────┤ -│ 0 │ 1 │ a │ 0 │ a │ let │ -│ 1 │ 2 │ b │ 1 │ c │ var │ -│ 2 │ 1 │ c │ 2 │ a │ let │ -│ 3 │ 1 │ c │ 3 │ a │ let │ -╰───┴───┴───┴───┴─────┴─────╯ - -``` - -Join one eager dataframe with a lazy dataframe -```nu -> let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | dfr into-df); - let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [2 "c" "var"] [3 "c" "const"]] | dfr into-lazy); - $df_a | dfr join $df_b a foo -╭───┬───┬───┬───┬─────┬─────╮ -│ # │ a │ b │ c │ bar │ ham │ -├───┼───┼───┼───┼─────┼─────┤ -│ 0 │ 1 │ a │ 0 │ a │ let │ -│ 1 │ 2 │ b │ 1 │ c │ var │ -│ 2 │ 1 │ c │ 2 │ a │ let │ -│ 3 │ 1 │ c │ 3 │ a │ let │ -╰───┴───┴───┴───┴─────┴─────╯ - -``` diff --git a/commands/docs/dfr_last.md b/commands/docs/dfr_last.md deleted file mode 100644 index b7d0817602..0000000000 --- a/commands/docs/dfr_last.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: dfr last -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates new dataframe with tail rows or creates a last expression. -usage: | - Creates new dataframe with tail rows or creates a last expression. -feature: dataframe ---- - - -# `dfr last` for [dataframe](/commands/categories/dataframe.md) - -
Creates new dataframe with tail rows or creates a last expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr last {flags} (rows)``` - -## Parameters - - - `rows`: Number of rows for tail - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create new dataframe with last rows -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr last 1 -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 3 │ 4 │ -╰───┴───┴───╯ - -``` - -Creates a last expression from a column -```nu -> dfr col a | dfr last - -``` diff --git a/commands/docs/dfr_lit.md b/commands/docs/dfr_lit.md deleted file mode 100644 index 40ee35946c..0000000000 --- a/commands/docs/dfr_lit.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr lit -categories: | - expression -version: 0.93.0 -expression: | - Creates a literal expression. -usage: | - Creates a literal expression. -feature: dataframe ---- - - -# `dfr lit` for [expression](/commands/categories/expression.md) - -
Creates a literal expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr lit {flags} (literal)``` - -## Parameters - - - `literal`: literal to construct the expression - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Created a literal expression and converts it to a nu object -```nu -> dfr lit 2 | dfr into-nu -╭───────┬─────────╮ -│ expr │ literal │ -│ value │ 2 │ -╰───────┴─────────╯ -``` diff --git a/commands/docs/dfr_lowercase.md b/commands/docs/dfr_lowercase.md deleted file mode 100644 index 890cdff505..0000000000 --- a/commands/docs/dfr_lowercase.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr lowercase -categories: | - dataframe -version: 0.93.0 -dataframe: | - Lowercase the strings in the column. -usage: | - Lowercase the strings in the column. -feature: dataframe ---- - - -# `dfr lowercase` for [dataframe](/commands/categories/dataframe.md) - -
Lowercase the strings in the column.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr lowercase {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Modifies strings to lowercase -```nu -> [Abc aBc abC] | dfr into-df | dfr lowercase -╭───┬─────╮ -│ # │ 0 │ -├───┼─────┤ -│ 0 │ abc │ -│ 1 │ abc │ -│ 2 │ abc │ -╰───┴─────╯ - -``` diff --git a/commands/docs/dfr_ls.md b/commands/docs/dfr_ls.md deleted file mode 100644 index a94012dfdd..0000000000 --- a/commands/docs/dfr_ls.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: dfr ls -categories: | - dataframe -version: 0.93.0 -dataframe: | - Lists stored dataframes. -usage: | - Lists stored dataframes. -feature: dataframe ---- - - -# `dfr ls` for [dataframe](/commands/categories/dataframe.md) - -
Lists stored dataframes.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr ls {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates a new dataframe and shows it in the dataframe list -```nu -> let test = ([[a b];[1 2] [3 4]] | dfr into-df); - ls - -``` diff --git a/commands/docs/dfr_max.md b/commands/docs/dfr_max.md deleted file mode 100644 index 2e3fb35f5e..0000000000 --- a/commands/docs/dfr_max.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr max -categories: | - expression -version: 0.93.0 -expression: | - Creates a max expression or aggregates columns to their max value. -usage: | - Creates a max expression or aggregates columns to their max value. -feature: dataframe ---- - - -# `dfr max` for [expression](/commands/categories/expression.md) - -
Creates a max expression or aggregates columns to their max value.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr max {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Max value from columns in a dataframe -```nu -> [[a b]; [6 2] [1 4] [4 1]] | dfr into-df | dfr max -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 6 │ 4 │ -╰───┴───┴───╯ - -``` - -Max aggregation for a group-by -```nu -> [[a b]; [one 2] [one 4] [two 1]] - | dfr into-df - | dfr group-by a - | dfr agg (dfr col b | dfr max) -╭───┬─────┬───╮ -│ # │ a │ b │ -├───┼─────┼───┤ -│ 0 │ one │ 4 │ -│ 1 │ two │ 1 │ -╰───┴─────┴───╯ - -``` diff --git a/commands/docs/dfr_mean.md b/commands/docs/dfr_mean.md deleted file mode 100644 index 5f972a52d2..0000000000 --- a/commands/docs/dfr_mean.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr mean -categories: | - expression -version: 0.93.0 -expression: | - Creates a mean expression for an aggregation or aggregates columns to their mean value. -usage: | - Creates a mean expression for an aggregation or aggregates columns to their mean value. -feature: dataframe ---- - - -# `dfr mean` for [expression](/commands/categories/expression.md) - -
Creates a mean expression for an aggregation or aggregates columns to their mean value.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr mean {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Mean value from columns in a dataframe -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr mean -╭───┬──────┬──────╮ -│ # │ a │ b │ -├───┼──────┼──────┤ -│ 0 │ 4.00 │ 2.00 │ -╰───┴──────┴──────╯ - -``` - -Mean aggregation for a group-by -```nu -> [[a b]; [one 2] [one 4] [two 1]] - | dfr into-df - | dfr group-by a - | dfr agg (dfr col b | dfr mean) -╭───┬─────┬──────╮ -│ # │ a │ b │ -├───┼─────┼──────┤ -│ 0 │ one │ 3.00 │ -│ 1 │ two │ 1.00 │ -╰───┴─────┴──────╯ - -``` diff --git a/commands/docs/dfr_median.md b/commands/docs/dfr_median.md deleted file mode 100644 index b8a699bb85..0000000000 --- a/commands/docs/dfr_median.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: dfr median -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Aggregates columns to their median value -usage: | - Aggregates columns to their median value -feature: dataframe ---- - - -# `dfr median` for [lazyframe](/commands/categories/lazyframe.md) - -
Aggregates columns to their median value
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr median {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Median value from columns in a dataframe -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr median -╭───┬──────┬──────╮ -│ # │ a │ b │ -├───┼──────┼──────┤ -│ 0 │ 4.00 │ 2.00 │ -╰───┴──────┴──────╯ - -``` diff --git a/commands/docs/dfr_melt.md b/commands/docs/dfr_melt.md deleted file mode 100644 index 9d7e154c1d..0000000000 --- a/commands/docs/dfr_melt.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: dfr melt -categories: | - dataframe -version: 0.93.0 -dataframe: | - Unpivot a DataFrame from wide to long format. -usage: | - Unpivot a DataFrame from wide to long format. -feature: dataframe ---- - - -# `dfr melt` for [dataframe](/commands/categories/dataframe.md) - -
Unpivot a DataFrame from wide to long format.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr melt {flags} ``` - -## Flags - - - `--columns, -c {table}`: column names for melting - - `--values, -v {table}`: column names used as value columns - - `--variable-name, -r {string}`: optional name for variable column - - `--value-name, -l {string}`: optional name for value column - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -melt dataframe -```nu -> [[a b c d]; [x 1 4 a] [y 2 5 b] [z 3 6 c]] | dfr into-df | dfr melt -c [b c] -v [a d] -╭───┬───┬───┬──────────┬───────╮ -│ # │ b │ c │ variable │ value │ -├───┼───┼───┼──────────┼───────┤ -│ 0 │ 1 │ 4 │ a │ x │ -│ 1 │ 2 │ 5 │ a │ y │ -│ 2 │ 3 │ 6 │ a │ z │ -│ 3 │ 1 │ 4 │ d │ a │ -│ 4 │ 2 │ 5 │ d │ b │ -│ 5 │ 3 │ 6 │ d │ c │ -╰───┴───┴───┴──────────┴───────╯ - -``` diff --git a/commands/docs/dfr_min.md b/commands/docs/dfr_min.md deleted file mode 100644 index 1667e36e65..0000000000 --- a/commands/docs/dfr_min.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr min -categories: | - expression -version: 0.93.0 -expression: | - Creates a min expression or aggregates columns to their min value. -usage: | - Creates a min expression or aggregates columns to their min value. -feature: dataframe ---- - - -# `dfr min` for [expression](/commands/categories/expression.md) - -
Creates a min expression or aggregates columns to their min value.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr min {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Min value from columns in a dataframe -```nu -> [[a b]; [6 2] [1 4] [4 1]] | dfr into-df | dfr min -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 1 │ -╰───┴───┴───╯ - -``` - -Min aggregation for a group-by -```nu -> [[a b]; [one 2] [one 4] [two 1]] - | dfr into-df - | dfr group-by a - | dfr agg (dfr col b | dfr min) -╭───┬─────┬───╮ -│ # │ a │ b │ -├───┼─────┼───┤ -│ 0 │ one │ 2 │ -│ 1 │ two │ 1 │ -╰───┴─────┴───╯ - -``` diff --git a/commands/docs/dfr_n-unique.md b/commands/docs/dfr_n-unique.md deleted file mode 100644 index b29e46dd2d..0000000000 --- a/commands/docs/dfr_n-unique.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: dfr n-unique -categories: | - dataframe -version: 0.93.0 -dataframe: | - Counts unique values. -usage: | - Counts unique values. -feature: dataframe ---- - - -# `dfr n-unique` for [dataframe](/commands/categories/dataframe.md) - -
Counts unique values.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr n-unique {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Counts unique values -```nu -> [1 1 2 2 3 3 4] | dfr into-df | dfr n-unique -╭───┬──────────────╮ -│ # │ count_unique │ -├───┼──────────────┤ -│ 0 │ 4 │ -╰───┴──────────────╯ - -``` - -Creates a is n-unique expression from a column -```nu -> dfr col a | dfr n-unique - -``` diff --git a/commands/docs/dfr_not.md b/commands/docs/dfr_not.md deleted file mode 100644 index 843e392463..0000000000 --- a/commands/docs/dfr_not.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr not -categories: | - dataframe -version: 0.93.0 -dataframe: | - Inverts boolean mask. -usage: | - Inverts boolean mask. -feature: dataframe ---- - - -# `dfr not` for [dataframe](/commands/categories/dataframe.md) - -
Inverts boolean mask.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr not {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Inverts boolean mask -```nu -> [true false true] | dfr into-df | dfr not -╭───┬───────╮ -│ # │ 0 │ -├───┼───────┤ -│ 0 │ false │ -│ 1 │ true │ -│ 2 │ false │ -╰───┴───────╯ - -``` diff --git a/commands/docs/dfr_open.md b/commands/docs/dfr_open.md deleted file mode 100644 index 9576e9ed70..0000000000 --- a/commands/docs/dfr_open.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: dfr open -categories: | - dataframe -version: 0.93.0 -dataframe: | - Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. -usage: | - Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. -feature: dataframe ---- - - -# `dfr open` for [dataframe](/commands/categories/dataframe.md) - -
Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr open {flags} (file)``` - -## Flags - - - `--lazy, -l`: creates a lazy dataframe - - `--type, -t {string}`: File type: csv, tsv, json, parquet, arrow, avro. If omitted, derive from file extension - - `--delimiter, -d {string}`: file delimiter character. CSV file - - `--no-header, -`: Indicates if file doesn't have header. CSV file - - `--infer-schema, - {number}`: Number of rows to infer the schema of the file. CSV file - - `--skip-rows, - {number}`: Number of rows to skip from file. CSV file - - `--columns, - {list}`: Columns to be selected from csv file. CSV and Parquet file - - `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files - -## Parameters - - - `file`: file path to load values from - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Takes a file name and creates a dataframe -```nu -> dfr open test.csv - -``` diff --git a/commands/docs/dfr_otherwise.md b/commands/docs/dfr_otherwise.md deleted file mode 100644 index 423be56b2b..0000000000 --- a/commands/docs/dfr_otherwise.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: dfr otherwise -categories: | - expression -version: 0.93.0 -expression: | - Completes a when expression. -usage: | - Completes a when expression. -feature: dataframe ---- - - -# `dfr otherwise` for [expression](/commands/categories/expression.md) - -
Completes a when expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr otherwise {flags} (otherwise expression)``` - -## Parameters - - - `otherwise expression`: expression to apply when no when predicate matches - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create a when conditions -```nu -> dfr when ((dfr col a) > 2) 4 | dfr otherwise 5 - -``` - -Create a when conditions -```nu -> dfr when ((dfr col a) > 2) 4 | dfr when ((dfr col a) < 0) 6 | dfr otherwise 0 - -``` - -Create a new column for the dataframe -```nu -> [[a b]; [6 2] [1 4] [4 1]] - | dfr into-lazy - | dfr with-column ( - dfr when ((dfr col a) > 2) 4 | dfr otherwise 5 | dfr as c - ) - | dfr with-column ( - dfr when ((dfr col a) > 5) 10 | dfr when ((dfr col a) < 2) 6 | dfr otherwise 0 | dfr as d - ) - | dfr collect -╭───┬───┬───┬───┬────╮ -│ # │ a │ b │ c │ d │ -├───┼───┼───┼───┼────┤ -│ 0 │ 6 │ 2 │ 4 │ 10 │ -│ 1 │ 1 │ 4 │ 5 │ 6 │ -│ 2 │ 4 │ 1 │ 4 │ 0 │ -╰───┴───┴───┴───┴────╯ - -``` diff --git a/commands/docs/dfr_quantile.md b/commands/docs/dfr_quantile.md deleted file mode 100644 index 3a5216f34a..0000000000 --- a/commands/docs/dfr_quantile.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: dfr quantile -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Aggregates the columns to the selected quantile. -usage: | - Aggregates the columns to the selected quantile. -feature: dataframe ---- - - -# `dfr quantile` for [lazyframe](/commands/categories/lazyframe.md) - -
Aggregates the columns to the selected quantile.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr quantile {flags} (quantile)``` - -## Parameters - - - `quantile`: quantile value for quantile operation - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -quantile value from columns in a dataframe -```nu -> [[a b]; [6 2] [1 4] [4 1]] | dfr into-df | dfr quantile 0.5 -╭───┬──────┬──────╮ -│ # │ a │ b │ -├───┼──────┼──────┤ -│ 0 │ 4.00 │ 2.00 │ -╰───┴──────┴──────╯ - -``` diff --git a/commands/docs/dfr_query.md b/commands/docs/dfr_query.md deleted file mode 100644 index 9a3b811d00..0000000000 --- a/commands/docs/dfr_query.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr query -categories: | - dataframe -version: 0.93.0 -dataframe: | - Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. -usage: | - Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. -feature: dataframe ---- - - -# `dfr query` for [dataframe](/commands/categories/dataframe.md) - -
Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr query {flags} (sql)``` - -## Parameters - - - `sql`: sql query - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Query dataframe using SQL -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr query 'select a from df' -╭───┬───╮ -│ # │ a │ -├───┼───┤ -│ 0 │ 1 │ -│ 1 │ 3 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_rename.md b/commands/docs/dfr_rename.md deleted file mode 100644 index de349f3a48..0000000000 --- a/commands/docs/dfr_rename.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: dfr rename -categories: | - dataframe or lazyframe -version: 0.93.0 -dataframe_or_lazyframe: | - Rename a dataframe column. -usage: | - Rename a dataframe column. -feature: dataframe ---- - - -# `dfr rename` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) - -
Rename a dataframe column.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr rename {flags} (columns) (new names)``` - -## Parameters - - - `columns`: Column(s) to be renamed. A string or list of strings - - `new names`: New names for the selected column(s). A string or list of strings - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Renames a series -```nu -> [5 6 7 8] | dfr into-df | dfr rename '0' new_name -╭───┬──────────╮ -│ # │ new_name │ -├───┼──────────┤ -│ 0 │ 5 │ -│ 1 │ 6 │ -│ 2 │ 7 │ -│ 3 │ 8 │ -╰───┴──────────╯ - -``` - -Renames a dataframe column -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr rename a a_new -╭───┬───────┬───╮ -│ # │ a_new │ b │ -├───┼───────┼───┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -╰───┴───────┴───╯ - -``` - -Renames two dataframe columns -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr rename [a b] [a_new b_new] -╭───┬───────┬───────╮ -│ # │ a_new │ b_new │ -├───┼───────┼───────┤ -│ 0 │ 1 │ 2 │ -│ 1 │ 3 │ 4 │ -╰───┴───────┴───────╯ - -``` diff --git a/commands/docs/dfr_replace-all.md b/commands/docs/dfr_replace-all.md deleted file mode 100644 index 402251fa1b..0000000000 --- a/commands/docs/dfr_replace-all.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr replace-all -categories: | - dataframe -version: 0.93.0 -dataframe: | - Replace all (sub)strings by a regex pattern. -usage: | - Replace all (sub)strings by a regex pattern. -feature: dataframe ---- - - -# `dfr replace-all` for [dataframe](/commands/categories/dataframe.md) - -
Replace all (sub)strings by a regex pattern.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr replace-all {flags} ``` - -## Flags - - - `--pattern, -p {string}`: Regex pattern to be matched - - `--replace, -r {string}`: replacing string - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Replaces string -```nu -> [abac abac abac] | dfr into-df | dfr replace-all --pattern a --replace A -╭───┬──────╮ -│ # │ 0 │ -├───┼──────┤ -│ 0 │ AbAc │ -│ 1 │ AbAc │ -│ 2 │ AbAc │ -╰───┴──────╯ - -``` diff --git a/commands/docs/dfr_replace.md b/commands/docs/dfr_replace.md deleted file mode 100644 index eb99734bea..0000000000 --- a/commands/docs/dfr_replace.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr replace -categories: | - dataframe -version: 0.93.0 -dataframe: | - Replace the leftmost (sub)string by a regex pattern. -usage: | - Replace the leftmost (sub)string by a regex pattern. -feature: dataframe ---- - - -# `dfr replace` for [dataframe](/commands/categories/dataframe.md) - -
Replace the leftmost (sub)string by a regex pattern.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr replace {flags} ``` - -## Flags - - - `--pattern, -p {string}`: Regex pattern to be matched - - `--replace, -r {string}`: replacing string - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Replaces string -```nu -> [abc abc abc] | dfr into-df | dfr replace --pattern ab --replace AB -╭───┬─────╮ -│ # │ 0 │ -├───┼─────┤ -│ 0 │ ABc │ -│ 1 │ ABc │ -│ 2 │ ABc │ -╰───┴─────╯ - -``` diff --git a/commands/docs/dfr_reverse.md b/commands/docs/dfr_reverse.md deleted file mode 100644 index 0549cc3684..0000000000 --- a/commands/docs/dfr_reverse.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr reverse -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Reverses the LazyFrame -usage: | - Reverses the LazyFrame -feature: dataframe ---- - - -# `dfr reverse` for [lazyframe](/commands/categories/lazyframe.md) - -
Reverses the LazyFrame
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr reverse {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Reverses the dataframe. -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr reverse -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 2 │ 2 │ -│ 1 │ 4 │ 2 │ -│ 2 │ 6 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_rolling.md b/commands/docs/dfr_rolling.md deleted file mode 100644 index ddb2527ec9..0000000000 --- a/commands/docs/dfr_rolling.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: dfr rolling -categories: | - dataframe -version: 0.93.0 -dataframe: | - Rolling calculation for a series. -usage: | - Rolling calculation for a series. -feature: dataframe ---- - - -# `dfr rolling` for [dataframe](/commands/categories/dataframe.md) - -
Rolling calculation for a series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr rolling {flags} (type) (window)``` - -## Parameters - - - `type`: rolling operation - - `window`: Window size for rolling - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Rolling sum for a series -```nu -> [1 2 3 4 5] | dfr into-df | dfr rolling sum 2 | dfr drop-nulls -╭───┬───────────────╮ -│ # │ 0_rolling_sum │ -├───┼───────────────┤ -│ 0 │ 3 │ -│ 1 │ 5 │ -│ 2 │ 7 │ -│ 3 │ 9 │ -╰───┴───────────────╯ - -``` - -Rolling max for a series -```nu -> [1 2 3 4 5] | dfr into-df | dfr rolling max 2 | dfr drop-nulls -╭───┬───────────────╮ -│ # │ 0_rolling_max │ -├───┼───────────────┤ -│ 0 │ 2 │ -│ 1 │ 3 │ -│ 2 │ 4 │ -│ 3 │ 5 │ -╰───┴───────────────╯ - -``` diff --git a/commands/docs/dfr_sample.md b/commands/docs/dfr_sample.md deleted file mode 100644 index 456d164d6a..0000000000 --- a/commands/docs/dfr_sample.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: dfr sample -categories: | - dataframe -version: 0.93.0 -dataframe: | - Create sample dataframe. -usage: | - Create sample dataframe. -feature: dataframe ---- - - -# `dfr sample` for [dataframe](/commands/categories/dataframe.md) - -
Create sample dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr sample {flags} ``` - -## Flags - - - `--n-rows, -n {int}`: number of rows to be taken from dataframe - - `--fraction, -f {number}`: fraction of dataframe to be taken - - `--seed, -s {number}`: seed for the selection - - `--replace, -e`: sample with replace - - `--shuffle, -u`: shuffle sample - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Sample rows from dataframe -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr sample --n-rows 1 - -``` - -Shows sample row using fraction and replace -```nu -> [[a b]; [1 2] [3 4] [5 6]] | dfr into-df | dfr sample --fraction 0.5 --replace - -``` diff --git a/commands/docs/dfr_schema.md b/commands/docs/dfr_schema.md deleted file mode 100644 index 8997863f1a..0000000000 --- a/commands/docs/dfr_schema.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr schema -categories: | - dataframe -version: 0.93.0 -dataframe: | - Show schema for a dataframe. -usage: | - Show schema for a dataframe. -feature: dataframe ---- - - -# `dfr schema` for [dataframe](/commands/categories/dataframe.md) - -
Show schema for a dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr schema {flags} ``` - -## Flags - - - `--datatype-list, -l`: creates a lazy dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Dataframe schema -```nu -> [[a b]; [1 "foo"] [3 "bar"]] | dfr into-df | dfr schema -╭───┬─────╮ -│ a │ i64 │ -│ b │ str │ -╰───┴─────╯ -``` diff --git a/commands/docs/dfr_select.md b/commands/docs/dfr_select.md deleted file mode 100644 index 13cc009294..0000000000 --- a/commands/docs/dfr_select.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: dfr select -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Selects columns from lazyframe. -usage: | - Selects columns from lazyframe. -feature: dataframe ---- - - -# `dfr select` for [lazyframe](/commands/categories/lazyframe.md) - -
Selects columns from lazyframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr select {flags} ...rest``` - -## Parameters - - - `...rest`: Expression(s) that define the column selection - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Select a column from the dataframe -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr select a -╭───┬───╮ -│ # │ a │ -├───┼───┤ -│ 0 │ 6 │ -│ 1 │ 4 │ -│ 2 │ 2 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_set-with-idx.md b/commands/docs/dfr_set-with-idx.md deleted file mode 100644 index 7352d1acb7..0000000000 --- a/commands/docs/dfr_set-with-idx.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr set-with-idx -categories: | - dataframe -version: 0.93.0 -dataframe: | - Sets value in the given index. -usage: | - Sets value in the given index. -feature: dataframe ---- - - -# `dfr set-with-idx` for [dataframe](/commands/categories/dataframe.md) - -
Sets value in the given index.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr set-with-idx {flags} (value)``` - -## Flags - - - `--indices, -i {any}`: list of indices indicating where to set the value - -## Parameters - - - `value`: value to be inserted in series - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Set value in selected rows from series -```nu -> let series = ([4 1 5 2 4 3] | dfr into-df); - let indices = ([0 2] | dfr into-df); - $series | dfr set-with-idx 6 --indices $indices -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 6 │ -│ 1 │ 1 │ -│ 2 │ 6 │ -│ 3 │ 2 │ -│ 4 │ 4 │ -│ 5 │ 3 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_set.md b/commands/docs/dfr_set.md deleted file mode 100644 index 5be614fd18..0000000000 --- a/commands/docs/dfr_set.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: dfr set -categories: | - dataframe -version: 0.93.0 -dataframe: | - Sets value where given mask is true. -usage: | - Sets value where given mask is true. -feature: dataframe ---- - - -# `dfr set` for [dataframe](/commands/categories/dataframe.md) - -
Sets value where given mask is true.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr set {flags} (value)``` - -## Flags - - - `--mask, -m {any}`: mask indicating insertions - -## Parameters - - - `value`: value to be inserted in series - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Shifts the values by a given period -```nu -> let s = ([1 2 2 3 3] | dfr into-df | dfr shift 2); - let mask = ($s | dfr is-null); - $s | dfr set 0 --mask $mask -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 0 │ -│ 1 │ 0 │ -│ 2 │ 1 │ -│ 3 │ 2 │ -│ 4 │ 2 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_shape.md b/commands/docs/dfr_shape.md deleted file mode 100644 index 8f40d12b67..0000000000 --- a/commands/docs/dfr_shape.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: dfr shape -categories: | - dataframe -version: 0.93.0 -dataframe: | - Shows column and row size for a dataframe. -usage: | - Shows column and row size for a dataframe. -feature: dataframe ---- - - -# `dfr shape` for [dataframe](/commands/categories/dataframe.md) - -
Shows column and row size for a dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr shape {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Shows row and column shape -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr shape -╭───┬──────┬─────────╮ -│ # │ rows │ columns │ -├───┼──────┼─────────┤ -│ 0 │ 2 │ 2 │ -╰───┴──────┴─────────╯ - -``` diff --git a/commands/docs/dfr_shift.md b/commands/docs/dfr_shift.md deleted file mode 100644 index 8bceed0597..0000000000 --- a/commands/docs/dfr_shift.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: dfr shift -categories: | - dataframe or lazyframe -version: 0.93.0 -dataframe_or_lazyframe: | - Shifts the values by a given period. -usage: | - Shifts the values by a given period. -feature: dataframe ---- - - -# `dfr shift` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) - -
Shifts the values by a given period.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr shift {flags} (period)``` - -## Flags - - - `--fill, -f {any}`: Expression used to fill the null values (lazy df) - -## Parameters - - - `period`: shift period - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Shifts the values by a given period -```nu -> [1 2 2 3 3] | dfr into-df | dfr shift 2 | dfr drop-nulls -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 1 │ -│ 1 │ 2 │ -│ 2 │ 2 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_slice.md b/commands/docs/dfr_slice.md deleted file mode 100644 index 5f957c0f19..0000000000 --- a/commands/docs/dfr_slice.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: dfr slice -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates new dataframe from a slice of rows. -usage: | - Creates new dataframe from a slice of rows. -feature: dataframe ---- - - -# `dfr slice` for [dataframe](/commands/categories/dataframe.md) - -
Creates new dataframe from a slice of rows.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr slice {flags} (offset) (size)``` - -## Parameters - - - `offset`: start of slice - - `size`: size of slice - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create new dataframe from a slice of the rows -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr slice 0 1 -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_sort-by.md b/commands/docs/dfr_sort-by.md deleted file mode 100644 index e386fda46e..0000000000 --- a/commands/docs/dfr_sort-by.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: dfr sort-by -categories: | - lazyframe -version: 0.93.0 -lazyframe: | - Sorts a lazy dataframe based on expression(s). -usage: | - Sorts a lazy dataframe based on expression(s). -feature: dataframe ---- - - -# `dfr sort-by` for [lazyframe](/commands/categories/lazyframe.md) - -
Sorts a lazy dataframe based on expression(s).
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr sort-by {flags} ...rest``` - -## Flags - - - `--reverse, -r {list}`: Reverse sorting. Default is false - - `--nulls-last, -n`: nulls are shown last in the dataframe - - `--maintain-order, -m`: Maintains order during sort - -## Parameters - - - `...rest`: sort expression for the dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Sort dataframe by one column -```nu -> [[a b]; [6 2] [1 4] [4 1]] | dfr into-df | dfr sort-by a -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 4 │ -│ 1 │ 4 │ 1 │ -│ 2 │ 6 │ 2 │ -╰───┴───┴───╯ - -``` - -Sort column using two columns -```nu -> [[a b]; [6 2] [1 1] [1 4] [2 4]] | dfr into-df | dfr sort-by [a b] -r [false true] -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 1 │ 4 │ -│ 1 │ 1 │ 1 │ -│ 2 │ 2 │ 4 │ -│ 3 │ 6 │ 2 │ -╰───┴───┴───╯ - -``` diff --git a/commands/docs/dfr_std.md b/commands/docs/dfr_std.md deleted file mode 100644 index 3f9f80dc07..0000000000 --- a/commands/docs/dfr_std.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr std -categories: | - expression -version: 0.93.0 -expression: | - Creates a std expression for an aggregation of std value from columns in a dataframe. -usage: | - Creates a std expression for an aggregation of std value from columns in a dataframe. -feature: dataframe ---- - - -# `dfr std` for [expression](/commands/categories/expression.md) - -
Creates a std expression for an aggregation of std value from columns in a dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr std {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Std value from columns in a dataframe -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr std -╭───┬──────┬──────╮ -│ # │ a │ b │ -├───┼──────┼──────┤ -│ 0 │ 2.00 │ 0.00 │ -╰───┴──────┴──────╯ - -``` - -Std aggregation for a group-by -```nu -> [[a b]; [one 2] [one 2] [two 1] [two 1]] - | dfr into-df - | dfr group-by a - | dfr agg (dfr col b | dfr std) -╭───┬─────┬──────╮ -│ # │ a │ b │ -├───┼─────┼──────┤ -│ 0 │ one │ 0.00 │ -│ 1 │ two │ 0.00 │ -╰───┴─────┴──────╯ - -``` diff --git a/commands/docs/dfr_str-lengths.md b/commands/docs/dfr_str-lengths.md deleted file mode 100644 index ba4173dbbc..0000000000 --- a/commands/docs/dfr_str-lengths.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr str-lengths -categories: | - dataframe -version: 0.93.0 -dataframe: | - Get lengths of all strings. -usage: | - Get lengths of all strings. -feature: dataframe ---- - - -# `dfr str-lengths` for [dataframe](/commands/categories/dataframe.md) - -
Get lengths of all strings.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr str-lengths {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns string lengths -```nu -> [a ab abc] | dfr into-df | dfr str-lengths -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 1 │ -│ 1 │ 2 │ -│ 2 │ 3 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_str-slice.md b/commands/docs/dfr_str-slice.md deleted file mode 100644 index 8eef277658..0000000000 --- a/commands/docs/dfr_str-slice.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: dfr str-slice -categories: | - dataframe -version: 0.93.0 -dataframe: | - Slices the string from the start position until the selected length. -usage: | - Slices the string from the start position until the selected length. -feature: dataframe ---- - - -# `dfr str-slice` for [dataframe](/commands/categories/dataframe.md) - -
Slices the string from the start position until the selected length.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr str-slice {flags} (start)``` - -## Flags - - - `--length, -l {int}`: optional length - -## Parameters - - - `start`: start of slice - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Creates slices from the strings -```nu -> [abcded abc321 abc123] | dfr into-df | dfr str-slice 1 --length 2 -╭───┬────╮ -│ # │ 0 │ -├───┼────┤ -│ 0 │ bc │ -│ 1 │ bc │ -│ 2 │ bc │ -╰───┴────╯ - -``` - -Creates slices from the strings without length -```nu -> [abcded abc321 abc123] | dfr into-df | dfr str-slice 1 -╭───┬───────╮ -│ # │ 0 │ -├───┼───────┤ -│ 0 │ bcded │ -│ 1 │ bc321 │ -│ 2 │ bc123 │ -╰───┴───────╯ - -``` diff --git a/commands/docs/dfr_strftime.md b/commands/docs/dfr_strftime.md deleted file mode 100644 index b1c22e737c..0000000000 --- a/commands/docs/dfr_strftime.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr strftime -categories: | - dataframe -version: 0.93.0 -dataframe: | - Formats date based on string rule. -usage: | - Formats date based on string rule. -feature: dataframe ---- - - -# `dfr strftime` for [dataframe](/commands/categories/dataframe.md) - -
Formats date based on string rule.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr strftime {flags} (fmt)``` - -## Parameters - - - `fmt`: Format rule - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Formats date -```nu -> let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); - let df = ([$dt $dt] | dfr into-df); - $df | dfr strftime "%Y/%m/%d" -╭───┬────────────╮ -│ # │ 0 │ -├───┼────────────┤ -│ 0 │ 2020/08/04 │ -│ 1 │ 2020/08/04 │ -╰───┴────────────╯ - -``` diff --git a/commands/docs/dfr_sum.md b/commands/docs/dfr_sum.md deleted file mode 100644 index d38cdba001..0000000000 --- a/commands/docs/dfr_sum.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr sum -categories: | - expression -version: 0.93.0 -expression: | - Creates a sum expression for an aggregation or aggregates columns to their sum value. -usage: | - Creates a sum expression for an aggregation or aggregates columns to their sum value. -feature: dataframe ---- - - -# `dfr sum` for [expression](/commands/categories/expression.md) - -
Creates a sum expression for an aggregation or aggregates columns to their sum value.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr sum {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Sums all columns in a dataframe -```nu -> [[a b]; [6 2] [1 4] [4 1]] | dfr into-df | dfr sum -╭───┬────┬───╮ -│ # │ a │ b │ -├───┼────┼───┤ -│ 0 │ 11 │ 7 │ -╰───┴────┴───╯ - -``` - -Sum aggregation for a group-by -```nu -> [[a b]; [one 2] [one 4] [two 1]] - | dfr into-df - | dfr group-by a - | dfr agg (dfr col b | dfr sum) -╭───┬─────┬───╮ -│ # │ a │ b │ -├───┼─────┼───┤ -│ 0 │ one │ 6 │ -│ 1 │ two │ 1 │ -╰───┴─────┴───╯ - -``` diff --git a/commands/docs/dfr_summary.md b/commands/docs/dfr_summary.md deleted file mode 100644 index a5c4c58cd0..0000000000 --- a/commands/docs/dfr_summary.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: dfr summary -categories: | - dataframe -version: 0.93.0 -dataframe: | - For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. -usage: | - For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. -feature: dataframe ---- - - -# `dfr summary` for [dataframe](/commands/categories/dataframe.md) - -
For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr summary {flags} ``` - -## Flags - - - `--quantiles, -q {table}`: provide optional quantiles - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -list dataframe descriptives -```nu -> [[a b]; [1 1] [1 1]] | dfr into-df | dfr summary -╭───┬────────────┬─────────┬─────────╮ -│ # │ descriptor │ a (i64) │ b (i64) │ -├───┼────────────┼─────────┼─────────┤ -│ 0 │ count │ 2.00 │ 2.00 │ -│ 1 │ sum │ 2.00 │ 2.00 │ -│ 2 │ mean │ 1.00 │ 1.00 │ -│ 3 │ median │ 1.00 │ 1.00 │ -│ 4 │ std │ 0.00 │ 0.00 │ -│ 5 │ min │ 1.00 │ 1.00 │ -│ 6 │ 25% │ 1.00 │ 1.00 │ -│ 7 │ 50% │ 1.00 │ 1.00 │ -│ 8 │ 75% │ 1.00 │ 1.00 │ -│ 9 │ max │ 1.00 │ 1.00 │ -╰───┴────────────┴─────────┴─────────╯ - -``` diff --git a/commands/docs/dfr_take.md b/commands/docs/dfr_take.md deleted file mode 100644 index 38bdbc66ff..0000000000 --- a/commands/docs/dfr_take.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: dfr take -categories: | - dataframe -version: 0.93.0 -dataframe: | - Creates new dataframe using the given indices. -usage: | - Creates new dataframe using the given indices. -feature: dataframe ---- - - -# `dfr take` for [dataframe](/commands/categories/dataframe.md) - -
Creates new dataframe using the given indices.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr take {flags} (indices)``` - -## Parameters - - - `indices`: list of indices used to take data - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Takes selected rows from dataframe -```nu -> let df = ([[a b]; [4 1] [5 2] [4 3]] | dfr into-df); - let indices = ([0 2] | dfr into-df); - $df | dfr take $indices -╭───┬───┬───╮ -│ # │ a │ b │ -├───┼───┼───┤ -│ 0 │ 4 │ 1 │ -│ 1 │ 4 │ 3 │ -╰───┴───┴───╯ - -``` - -Takes selected rows from series -```nu -> let series = ([4 1 5 2 4 3] | dfr into-df); - let indices = ([0 2] | dfr into-df); - $series | dfr take $indices -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 4 │ -│ 1 │ 5 │ -╰───┴───╯ - -``` diff --git a/commands/docs/dfr_to-arrow.md b/commands/docs/dfr_to-arrow.md deleted file mode 100644 index 62afacbab9..0000000000 --- a/commands/docs/dfr_to-arrow.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: dfr to-arrow -categories: | - dataframe -version: 0.93.0 -dataframe: | - Saves dataframe to arrow file. -usage: | - Saves dataframe to arrow file. -feature: dataframe ---- - - -# `dfr to-arrow` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to arrow file.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr to-arrow {flags} (file)``` - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to arrow file -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-arrow test.arrow - -``` diff --git a/commands/docs/dfr_to-avro.md b/commands/docs/dfr_to-avro.md deleted file mode 100644 index d078c07ff8..0000000000 --- a/commands/docs/dfr_to-avro.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dfr to-avro -categories: | - dataframe -version: 0.93.0 -dataframe: | - Saves dataframe to avro file. -usage: | - Saves dataframe to avro file. -feature: dataframe ---- - - -# `dfr to-avro` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to avro file.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr to-avro {flags} (file)``` - -## Flags - - - `--compression, -c {string}`: use compression, supports deflate or snappy - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to avro file -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-avro test.avro - -``` diff --git a/commands/docs/dfr_to-csv.md b/commands/docs/dfr_to-csv.md deleted file mode 100644 index 8cae3904d0..0000000000 --- a/commands/docs/dfr_to-csv.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: dfr to-csv -categories: | - dataframe -version: 0.93.0 -dataframe: | - Saves dataframe to CSV file. -usage: | - Saves dataframe to CSV file. -feature: dataframe ---- - - -# `dfr to-csv` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to CSV file.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr to-csv {flags} (file)``` - -## Flags - - - `--delimiter, -d {string}`: file delimiter character - - `--no-header, -`: Indicates if file doesn't have header - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to CSV file -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv - -``` - -Saves dataframe to CSV file using other delimiter -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv --delimiter '|' - -``` diff --git a/commands/docs/dfr_to-jsonl.md b/commands/docs/dfr_to-jsonl.md deleted file mode 100644 index 71373e2b20..0000000000 --- a/commands/docs/dfr_to-jsonl.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: dfr to-jsonl -categories: | - dataframe -version: 0.93.0 -dataframe: | - Saves dataframe to a JSON lines file. -usage: | - Saves dataframe to a JSON lines file. -feature: dataframe ---- - - -# `dfr to-jsonl` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to a JSON lines file.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr to-jsonl {flags} (file)``` - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to JSON lines file -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-jsonl test.jsonl - -``` diff --git a/commands/docs/dfr_to-parquet.md b/commands/docs/dfr_to-parquet.md deleted file mode 100644 index 0c4bf9720f..0000000000 --- a/commands/docs/dfr_to-parquet.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: dfr to-parquet -categories: | - dataframe -version: 0.93.0 -dataframe: | - Saves dataframe to parquet file. -usage: | - Saves dataframe to parquet file. -feature: dataframe ---- - - -# `dfr to-parquet` for [dataframe](/commands/categories/dataframe.md) - -
Saves dataframe to parquet file.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr to-parquet {flags} (file)``` - -## Parameters - - - `file`: file path to save dataframe - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Saves dataframe to parquet file -```nu -> [[a b]; [1 2] [3 4]] | dfr into-df | dfr to-parquet test.parquet - -``` diff --git a/commands/docs/dfr_unique.md b/commands/docs/dfr_unique.md deleted file mode 100644 index ef2c2c94fa..0000000000 --- a/commands/docs/dfr_unique.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: dfr unique -categories: | - dataframe or lazyframe -version: 0.93.0 -dataframe_or_lazyframe: | - Returns unique values from a dataframe. -usage: | - Returns unique values from a dataframe. -feature: dataframe ---- - - -# `dfr unique` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) - -
Returns unique values from a dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr unique {flags} ``` - -## Flags - - - `--subset, -s {any}`: Subset of column(s) to use to maintain rows (lazy df) - - `--last, -l`: Keeps last unique value. Default keeps first value (lazy df) - - `--maintain-order, -k`: Keep the same order as the original DataFrame (lazy df) - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Returns unique values from a series -```nu -> [2 2 2 2 2] | dfr into-df | dfr unique -╭───┬───╮ -│ # │ 0 │ -├───┼───┤ -│ 0 │ 2 │ -╰───┴───╯ - -``` - -Creates a is unique expression from a column -```nu -> col a | unique - -``` diff --git a/commands/docs/dfr_uppercase.md b/commands/docs/dfr_uppercase.md deleted file mode 100644 index 4d4c87b81a..0000000000 --- a/commands/docs/dfr_uppercase.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: dfr uppercase -categories: | - dataframe -version: 0.93.0 -dataframe: | - Uppercase the strings in the column. -usage: | - Uppercase the strings in the column. -feature: dataframe ---- - - -# `dfr uppercase` for [dataframe](/commands/categories/dataframe.md) - -
Uppercase the strings in the column.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr uppercase {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Modifies strings to uppercase -```nu -> [Abc aBc abC] | dfr into-df | dfr uppercase -╭───┬─────╮ -│ # │ 0 │ -├───┼─────┤ -│ 0 │ ABC │ -│ 1 │ ABC │ -│ 2 │ ABC │ -╰───┴─────╯ - -``` diff --git a/commands/docs/dfr_value-counts.md b/commands/docs/dfr_value-counts.md deleted file mode 100644 index 59bb3d4ff7..0000000000 --- a/commands/docs/dfr_value-counts.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: dfr value-counts -categories: | - dataframe -version: 0.93.0 -dataframe: | - Returns a dataframe with the counts for unique values in series. -usage: | - Returns a dataframe with the counts for unique values in series. -feature: dataframe ---- - - -# `dfr value-counts` for [dataframe](/commands/categories/dataframe.md) - -
Returns a dataframe with the counts for unique values in series.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr value-counts {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Calculates value counts -```nu -> [5 5 5 5 6 6] | dfr into-df | dfr value-counts -╭───┬───┬───────╮ -│ # │ 0 │ count │ -├───┼───┼───────┤ -│ 0 │ 5 │ 4 │ -│ 1 │ 6 │ 2 │ -╰───┴───┴───────╯ - -``` diff --git a/commands/docs/dfr_var.md b/commands/docs/dfr_var.md deleted file mode 100644 index 1054d732c6..0000000000 --- a/commands/docs/dfr_var.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: dfr var -categories: | - expression -version: 0.93.0 -expression: | - Create a var expression for an aggregation. -usage: | - Create a var expression for an aggregation. -feature: dataframe ---- - - -# `dfr var` for [expression](/commands/categories/expression.md) - -
Create a var expression for an aggregation.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr var {flags} ``` - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Var value from columns in a dataframe or aggregates columns to their var value -```nu -> [[a b]; [6 2] [4 2] [2 2]] | dfr into-df | dfr var -╭───┬──────┬──────╮ -│ # │ a │ b │ -├───┼──────┼──────┤ -│ 0 │ 4.00 │ 0.00 │ -╰───┴──────┴──────╯ - -``` - -Var aggregation for a group-by -```nu -> [[a b]; [one 2] [one 2] [two 1] [two 1]] - | dfr into-df - | dfr group-by a - | dfr agg (dfr col b | dfr var) -╭───┬─────┬──────╮ -│ # │ a │ b │ -├───┼─────┼──────┤ -│ 0 │ one │ 0.00 │ -│ 1 │ two │ 0.00 │ -╰───┴─────┴──────╯ - -``` diff --git a/commands/docs/dfr_when.md b/commands/docs/dfr_when.md deleted file mode 100644 index 44fe978c27..0000000000 --- a/commands/docs/dfr_when.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: dfr when -categories: | - expression -version: 0.93.0 -expression: | - Creates and modifies a when expression. -usage: | - Creates and modifies a when expression. -feature: dataframe ---- - - -# `dfr when` for [expression](/commands/categories/expression.md) - -
Creates and modifies a when expression.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr when {flags} (when expression) (then expression)``` - -## Parameters - - - `when expression`: when expression used for matching - - `then expression`: expression that will be applied when predicate is true - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Create a when conditions -```nu -> dfr when ((dfr col a) > 2) 4 - -``` - -Create a when conditions -```nu -> dfr when ((dfr col a) > 2) 4 | dfr when ((dfr col a) < 0) 6 - -``` - -Create a new column for the dataframe -```nu -> [[a b]; [6 2] [1 4] [4 1]] - | dfr into-lazy - | dfr with-column ( - dfr when ((dfr col a) > 2) 4 | dfr otherwise 5 | dfr as c - ) - | dfr with-column ( - dfr when ((dfr col a) > 5) 10 | dfr when ((dfr col a) < 2) 6 | dfr otherwise 0 | dfr as d - ) - | dfr collect -╭───┬───┬───┬───┬────╮ -│ # │ a │ b │ c │ d │ -├───┼───┼───┼───┼────┤ -│ 0 │ 6 │ 2 │ 4 │ 10 │ -│ 1 │ 1 │ 4 │ 5 │ 6 │ -│ 2 │ 4 │ 1 │ 4 │ 0 │ -╰───┴───┴───┴───┴────╯ - -``` diff --git a/commands/docs/dfr_with-column.md b/commands/docs/dfr_with-column.md deleted file mode 100644 index 953a4cd585..0000000000 --- a/commands/docs/dfr_with-column.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: dfr with-column -categories: | - dataframe or lazyframe -version: 0.93.0 -dataframe_or_lazyframe: | - Adds a series to the dataframe. -usage: | - Adds a series to the dataframe. -feature: dataframe ---- - - -# `dfr with-column` for [dataframe or lazyframe](/commands/categories/dataframe or lazyframe.md) - -
Adds a series to the dataframe.
- -::: warning -Dataframe commands were not shipped in the official binaries by default, you have to build it with `--features=dataframe` flag -::: - -## Signature - -```> dfr with-column {flags} ...rest``` - -## Flags - - - `--name, -n {string}`: new column name - -## Parameters - - - `...rest`: series to be added or expressions used to define the new columns - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Adds a series to the dataframe -```nu -> [[a b]; [1 2] [3 4]] - | dfr into-df - | dfr with-column ([5 6] | dfr into-df) --name c -╭───┬───┬───┬───╮ -│ # │ a │ b │ c │ -├───┼───┼───┼───┤ -│ 0 │ 1 │ 2 │ 5 │ -│ 1 │ 3 │ 4 │ 6 │ -╰───┴───┴───┴───╯ - -``` - -Adds a series to the dataframe -```nu -> [[a b]; [1 2] [3 4]] - | dfr into-lazy - | dfr with-column [ - ((dfr col a) * 2 | dfr as "c") - ((dfr col a) * 3 | dfr as "d") - ] - | dfr collect -╭───┬───┬───┬───┬───╮ -│ # │ a │ b │ c │ d │ -├───┼───┼───┼───┼───┤ -│ 0 │ 1 │ 2 │ 2 │ 3 │ -│ 1 │ 3 │ 4 │ 6 │ 9 │ -╰───┴───┴───┴───┴───╯ - -``` diff --git a/commands/docs/do.md b/commands/docs/do.md index 91603d5de4..de5639f2ac 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.93.0 +version: 0.94.0 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 29c42cc54a..3cddc33d4c 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | @@ -79,7 +79,7 @@ Remove the last row in a table ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- | -| [`drop column`](/commands/docs/drop_column.md) | Builtin | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. | -| [`drop nth`](/commands/docs/drop_nth.md) | Builtin | Drop the selected rows. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------- | --------------------------------------------------------------------------------------------------- | -------- | +| [`drop column`](/commands/docs/drop_column.md) | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. | built-in | +| [`drop nth`](/commands/docs/drop_nth.md) | Drop the selected rows. | built-in | \ No newline at end of file diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index 2fd966898d..c0a79a80cb 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. usage: | diff --git a/commands/docs/drop_nth.md b/commands/docs/drop_nth.md index 7268b5efd1..869abc9956 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 1d2b05f740..2bbe7a98bf 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index c9a34fb102..61b38889d4 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -100,6 +100,6 @@ with 'transpose' first. ## Subcommands: -| name | type | usage | -| -------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------- | -| [`each while`](/commands/docs/each_while.md) | Builtin | Run a block on each row of the input list until a null is found, then create a new list with the results. | +| name | usage | type | +| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -------- | +| [`each while`](/commands/docs/each_while.md) | Run a closure on each row of the input list until a null is found, then create a new list with the results. | built-in | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index b7b9c0bd48..a448588587 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,18 +2,18 @@ title: each while categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | - Run a block on each row of the input list until a null is found, then create a new list with the results. + Run a closure on each row of the input list until a null is found, then create a new list with the results. usage: | - Run a block on each row of the input list until a null is found, then create a new list with the results. + Run a closure on each row of the input list until a null is found, then create a new list with the results. feature: default --- # `each while` for [filters](/commands/categories/filters.md) -
Run a block on each row of the input list until a null is found, then create a new list with the results.
+
Run a closure on each row of the input list until a null is found, then create a new list with the results.
## Signature diff --git a/commands/docs/echo.md b/commands/docs/echo.md index e4ec03e829..63154bcb2b 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.93.0 +version: 0.94.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 239b5285df..3c7689c29b 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Encode a string into bytes. usage: | @@ -66,7 +66,7 @@ documentation link at https://docs.rs/encoding_rs/latest/encoding_rs/#statics ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | --------------------------------------------- | -| [`encode base64`](/commands/docs/encode_base64.md) | Builtin | Encode a string or binary value using Base64. | -| [`encode hex`](/commands/docs/encode_hex.md) | Builtin | Encode a binary value using hex. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | --------------------------------------------- | -------- | +| [`encode base64`](/commands/docs/encode_base64.md) | Encode a string or binary value using Base64. | built-in | +| [`encode hex`](/commands/docs/encode_hex.md) | Encode a binary value using hex. | built-in | \ No newline at end of file diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index dcea7f78da..9bb5ea3e5f 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.93.0 +version: 0.94.0 hash: | Encode a string or binary value using Base64. usage: | @@ -57,5 +57,5 @@ U29tZSBEYXRh Encode a string with the binhex character set ```nu > 'Some Data' | encode base64 --character-set binhex -7epXB5"%A@4J +8fpYC5"%BA4K ``` diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index a6ca5fd0f2..e00366d014 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Encode a binary value using hex. usage: | diff --git a/commands/docs/enter.md b/commands/docs/enter.md index 0225edb63b..bc3761a5d7 100644 --- a/commands/docs/enter.md +++ b/commands/docs/enter.md @@ -2,7 +2,7 @@ title: enter categories: | shells -version: 0.92.0 +version: 0.94.0 shells: | Enters a new shell at the given path. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 67f7e07316..5cb50a8f9a 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index f496c5e33b..b6da43a549 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.93.0 +version: 0.94.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 7ebb3aef38..37470b4b9a 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Show (or skip) every n-th row, starting from the first one. usage: | diff --git a/commands/docs/exec.md b/commands/docs/exec.md index 877e2fb676..0991a8eca4 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.93.0 +version: 0.94.0 system: | Execute a command, replacing or exiting the current process, depending on platform. usage: | diff --git a/commands/docs/exit.md b/commands/docs/exit.md index 2f941da98b..57b404a867 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.93.0 +version: 0.94.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 1e1ee66563..bc752f7489 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index b12b42073d..6a566a6664 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.93.0 +version: 0.94.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | @@ -23,7 +23,7 @@ feature: default - `--head, - {bool}`: Show or hide column headers (default true) - `--index, -i`: Show row indexes when viewing a list - - `--reverse, -r`: Start with the viewport scrolled to the bottom + - `--tail, -t`: Start with the viewport scrolled to the bottom - `--peek, -p`: When quitting, output the value of the cell the cursor was on @@ -35,9 +35,9 @@ feature: default ## Examples -Explore the system information record +Explore the system host information record ```nu -> sys | explore +> sys host | explore ``` diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 5c393f1d87..0faaadea27 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.93.0 +version: 0.94.0 env: | Run a block and preserve its environment in a current scope. usage: | diff --git a/commands/docs/export.md b/commands/docs/export.md index ec65ea6022..e310b2ab94 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.93.0 +version: 0.94.0 core: | Export definitions or environment variables from a module. usage: | @@ -40,11 +40,11 @@ This command is a parser keyword. For details, check: ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | -------------------------------------------------------------------------------- | -| [`export alias`](/commands/docs/export_alias.md) | Builtin | Alias a command (with optional flags) to a new name and export it from a module. | -| [`export const`](/commands/docs/export_const.md) | Builtin | Use parse-time constant from a module and export them from this module. | -| [`export def`](/commands/docs/export_def.md) | Builtin | Define a custom command and export it from a module. | -| [`export extern`](/commands/docs/export_extern.md) | Builtin | Define an extern and export it from a module. | -| [`export module`](/commands/docs/export_module.md) | Builtin | Export a custom module from a module. | -| [`export use`](/commands/docs/export_use.md) | Builtin | Use definitions from a module and export them from this module. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | -------------------------------------------------------------------------------- | ------- | +| [`export alias`](/commands/docs/export_alias.md) | Alias a command (with optional flags) to a new name and export it from a module. | keyword | +| [`export const`](/commands/docs/export_const.md) | Use parse-time constant from a module and export them from this module. | keyword | +| [`export def`](/commands/docs/export_def.md) | Define a custom command and export it from a module. | keyword | +| [`export extern`](/commands/docs/export_extern.md) | Define an extern and export it from a module. | keyword | +| [`export module`](/commands/docs/export_module.md) | Export a custom module from a module. | keyword | +| [`export use`](/commands/docs/export_use.md) | Use definitions from a module and export them from this module. | keyword | \ No newline at end of file diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index e3f59eaab8..37a760816c 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.93.0 +version: 0.94.0 core: | Alias a command (with optional flags) to a new name and export it from a module. usage: | diff --git a/commands/docs/export_const.md b/commands/docs/export_const.md index d64f5c7baa..cadc909693 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.93.0 +version: 0.94.0 core: | Use parse-time constant from a module and export them from this module. usage: | diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index 5132001170..4ec4370381 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.93.0 +version: 0.94.0 core: | Define a custom command and export it from a module. usage: | diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index 08847242ad..6b1dc53577 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.93.0 +version: 0.94.0 core: | Define an extern and export it from a module. usage: | diff --git a/commands/docs/export_module.md b/commands/docs/export_module.md index 85c2a38ce2..779587c165 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.93.0 +version: 0.94.0 core: | Export a custom module from a module. usage: | diff --git a/commands/docs/export_use.md b/commands/docs/export_use.md index 4bbcd6bc88..5b063c02f2 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.93.0 +version: 0.94.0 core: | Use definitions from a module and export them from this module. usage: | diff --git a/commands/docs/extern.md b/commands/docs/extern.md index 586a074563..a02eaaf5ad 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.93.0 +version: 0.94.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 6b67d34053..e07312214d 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Fill and Align. usage: | @@ -53,10 +53,10 @@ Fill a string on the right side to a width of 15 with the character '─' ────────nushell ``` -Fill a string on both sides to a width of 15 with the character '─' +Fill an empty string with 10 '─' characters ```nu -> 'nushell' | fill --alignment m --character '─' --width 15 -────nushell──── +> '' | fill --character '─' --width 10 +────────── ``` Fill a number on the left side to a width of 5 with the character '0' diff --git a/commands/docs/filter.md b/commands/docs/filter.md index d08fc157ea..3a9b6df857 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index 9a1ed61a78..097699907c 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index 962b3ddbe1..51dc4ec7df 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. usage: | diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 8878e3d23b..c2960e6fe2 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index 6f81c9e1c5..a161537c57 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index 67c0727d8c..fccf55ae0a 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.93.0 +version: 0.94.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index ceff8231d6..689286aef4 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Various commands for formatting data. usage: | @@ -31,9 +31,9 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------------ | ------- | -------------------------------------------------------- | -| [`format date`](/commands/docs/format_date.md) | Builtin | Format a given date using a format string. | -| [`format duration`](/commands/docs/format_duration.md) | Builtin | Outputs duration with a specified unit of time. | -| [`format filesize`](/commands/docs/format_filesize.md) | Builtin | Converts a column of filesizes to some specified format. | -| [`format pattern`](/commands/docs/format_pattern.md) | Builtin | Format columns into a string using a simple pattern. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------------ | -------------------------------------------------------- | -------- | +| [`format date`](/commands/docs/format_date.md) | Format a given date using a format string. | built-in | +| [`format duration`](/commands/docs/format_duration.md) | Outputs duration with a specified unit of time. | built-in | +| [`format filesize`](/commands/docs/format_filesize.md) | Converts a column of filesizes to some specified format. | built-in | +| [`format pattern`](/commands/docs/format_pattern.md) | Format columns into a string using a simple pattern. | built-in | \ No newline at end of file diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 2e379a43e5..a71e607aad 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | date -version: 0.93.0 +version: 0.94.0 date: | Format a given date using a format string. usage: | diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 3996fe1043..47ed465507 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Outputs duration with a specified unit of time. usage: | diff --git a/commands/docs/format_filesize.md b/commands/docs/format_filesize.md index 5b091e205d..64823982f5 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Converts a column of filesizes to some specified format. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 470f4e548f..a6f806baa2 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 3ef64aee81..1b3b122b21 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse a string or binary data into structured data. usage: | @@ -31,23 +31,23 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`from csv`](/commands/docs/from_csv.md) | Builtin | Parse text as .csv and create table. | -| [`from eml`](/commands/docs/from_eml.md) | Builtin,Plugin | Parse text as .eml and create record. | -| [`from ics`](/commands/docs/from_ics.md) | Builtin,Plugin | Parse text as .ics and create table. | -| [`from ini`](/commands/docs/from_ini.md) | Builtin,Plugin | Parse text as .ini and create table. | -| [`from json`](/commands/docs/from_json.md) | Builtin | Convert from json to structured data. | -| [`from msgpack`](/commands/docs/from_msgpack.md) | Builtin | Convert MessagePack data into Nu values. | -| [`from msgpackz`](/commands/docs/from_msgpackz.md) | Builtin | Convert brotli-compressed MessagePack data into Nu values. | -| [`from nuon`](/commands/docs/from_nuon.md) | Builtin | Convert from nuon to structured data. | -| [`from ods`](/commands/docs/from_ods.md) | Builtin | Parse OpenDocument Spreadsheet(.ods) data and create table. | -| [`from ssv`](/commands/docs/from_ssv.md) | Builtin | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | -| [`from toml`](/commands/docs/from_toml.md) | Builtin | Parse text as .toml and create record. | -| [`from tsv`](/commands/docs/from_tsv.md) | Builtin | Parse text as .tsv and create table. | -| [`from url`](/commands/docs/from_url.md) | Builtin | Parse url-encoded string as a record. | -| [`from vcf`](/commands/docs/from_vcf.md) | Builtin,Plugin | Parse text as .vcf and create table. | -| [`from xlsx`](/commands/docs/from_xlsx.md) | Builtin | Parse binary Excel(.xlsx) data and create table. | -| [`from xml`](/commands/docs/from_xml.md) | Builtin | Parse text as .xml and create record. | -| [`from yaml`](/commands/docs/from_yaml.md) | Builtin | Parse text as .yaml/.yml and create table. | -| [`from yml`](/commands/docs/from_yml.md) | Builtin | Parse text as .yaml/.yml and create table. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------- | +| [`from csv`](/commands/docs/from_csv.md) | Parse text as .csv and create table. | built-in | +| [`from eml`](/commands/docs/from_eml.md) | Parse text as .eml and create record. | plugin | +| [`from ics`](/commands/docs/from_ics.md) | Parse text as .ics and create table. | plugin | +| [`from ini`](/commands/docs/from_ini.md) | Parse text as .ini and create table. | plugin | +| [`from json`](/commands/docs/from_json.md) | Convert from json to structured data. | built-in | +| [`from msgpack`](/commands/docs/from_msgpack.md) | Convert MessagePack data into Nu values. | built-in | +| [`from msgpackz`](/commands/docs/from_msgpackz.md) | Convert brotli-compressed MessagePack data into Nu values. | built-in | +| [`from nuon`](/commands/docs/from_nuon.md) | Convert from nuon to structured data. | built-in | +| [`from ods`](/commands/docs/from_ods.md) | Parse OpenDocument Spreadsheet(.ods) data and create table. | built-in | +| [`from ssv`](/commands/docs/from_ssv.md) | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | built-in | +| [`from toml`](/commands/docs/from_toml.md) | Parse text as .toml and create record. | built-in | +| [`from tsv`](/commands/docs/from_tsv.md) | Parse text as .tsv and create table. | built-in | +| [`from url`](/commands/docs/from_url.md) | Parse url-encoded string as a record. | built-in | +| [`from vcf`](/commands/docs/from_vcf.md) | Parse text as .vcf and create table. | plugin | +| [`from xlsx`](/commands/docs/from_xlsx.md) | Parse binary Excel(.xlsx) data and create table. | built-in | +| [`from xml`](/commands/docs/from_xml.md) | Parse text as .xml and create record. | built-in | +| [`from yaml`](/commands/docs/from_yaml.md) | Parse text as .yaml/.yml and create table. | built-in | +| [`from yml`](/commands/docs/from_yml.md) | Parse text as .yaml/.yml and create table. | built-in | \ No newline at end of file diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index 1c4cad3fee..9182567f02 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .csv and create table. usage: | diff --git a/commands/docs/from_eml.md b/commands/docs/from_eml.md index aa4a40553f..4da4b94ee6 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .eml and create record. usage: | diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index 3827fcfa66..f9a1391852 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .ics and create table. usage: | @@ -36,10 +36,11 @@ Converts ics formatted string to table ```nu > 'BEGIN:VCALENDAR END:VCALENDAR' | from ics -╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────╮ -│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ timezones │ -├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┤ -│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ -╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────╯ +╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬───────────╮ +│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ timezones │ +├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼───────────┤ +│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 │ +│ │ │ │ │ │ │ │ items] │ +╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴───────────╯ ``` diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index d057d2cdee..0a1ceeb08e 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .ini and create table. usage: | diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index d35db81dfa..2ee31f5c16 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert from json to structured data. usage: | @@ -61,3 +61,16 @@ Parse json strictly which will error on comments and trailing commas │ b │ 2 │ ╰───┴───╯ ``` + +Parse a stream of line-delimited JSON values +```nu +> '{ "a": 1 } +{ "b": 2 }' | from json --objects +╭───┬────┬────╮ +│ # │ a │ b │ +├───┼────┼────┤ +│ 0 │ 1 │ ❎ │ +│ 1 │ ❎ │ 2 │ +╰───┴────┴────╯ + +``` diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index fee6cc91f7..52f49792c9 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index b4cdeb4e16..1852ba9710 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert brotli-compressed MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 2942164646..6ee40342a8 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 3f1caa8723..463ae6c36f 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 574e762253..00f51a8e1c 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 5a09d6588f..17901c3488 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .toml and create record. usage: | diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md index d74630636e..9a117a3b95 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index c649ff1b4b..33b9521a12 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse url-encoded string as a record. usage: | diff --git a/commands/docs/from_vcf.md b/commands/docs/from_vcf.md index a25f4e9e7d..8bd9ae039f 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .vcf and create table. usage: | diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 5f305b3e31..3415c06bec 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index 7969b82c43..7d4050931b 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .xml and create record. usage: | diff --git a/commands/docs/from_yaml.md b/commands/docs/from_yaml.md index 8b62e08b71..483bc8fddf 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/from_yml.md b/commands/docs/from_yml.md index 2c324d852b..c697c7bc65 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/g.md b/commands/docs/g.md index 76eadf78d8..5e12d75a60 100644 --- a/commands/docs/g.md +++ b/commands/docs/g.md @@ -2,7 +2,7 @@ title: g categories: | shells -version: 0.92.0 +version: 0.94.0 shells: | Switch to a given shell, or list all shells if no given shell number. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index d9c302922e..284ce127cb 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.93.0 +version: 0.94.0 generators: | Generate a list of values by successively invoking a closure. usage: | diff --git a/commands/docs/get.md b/commands/docs/get.md index 9442b991b6..bcb039592b 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Extract data using a cell path. usage: | @@ -60,7 +60,7 @@ Get a cell from a table A0 ``` -Extract the name of the 3rd record in a list (same as `ls | $in.name`) +Extract the name of the 3rd record in a list (same as `ls | $in.name.2`) ```nu > ls | get name.2 @@ -72,12 +72,6 @@ Extract the name of the 3rd record in a list ``` -Extract the cpu list from the sys information record -```nu -> sys | get cpu - -``` - Getting Path/PATH in a case insensitive way ```nu > $env | get paTH diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 7ea1f960c0..55d4fa6b01 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | diff --git a/commands/docs/grid.md b/commands/docs/grid.md index 9ef9c2d703..473651c838 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.93.0 +version: 0.94.0 viewers: | Renders the output to a textual terminal grid. usage: | diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index 8b53bc4b7c..1ad7d9d9dc 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/group.md b/commands/docs/group.md index 3493c1ee24..0a6be744a5 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Groups input into groups of `group_size`. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 872c31ac18..e1a39f1a4f 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.93.0 +version: 0.94.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index dc68901467..0a87aa395f 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.93.0 +version: 0.94.0 hash: | Apply hash function. usage: | @@ -31,7 +31,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | --------------------------------------------- | -| [`hash md5`](/commands/docs/hash_md5.md) | Builtin | Hash a value using the md5 hash algorithm. | -| [`hash sha256`](/commands/docs/hash_sha256.md) | Builtin | Hash a value using the sha256 hash algorithm. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------- | --------------------------------------------- | -------- | +| [`hash md5`](/commands/docs/hash_md5.md) | Hash a value using the md5 hash algorithm. | built-in | +| [`hash sha256`](/commands/docs/hash_sha256.md) | Hash a value using the sha256 hash algorithm. | built-in | \ No newline at end of file diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index 8f47115859..89f96b94c3 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.93.0 +version: 0.94.0 hash: | Hash a value using the md5 hash algorithm. usage: | diff --git a/commands/docs/hash_sha256.md b/commands/docs/hash_sha256.md index 4fb52bd729..4850c97529 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.93.0 +version: 0.94.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 6002f80a40..6e7de55ad7 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Use the first row of the table as column names. usage: | diff --git a/commands/docs/help.md b/commands/docs/help.md index 3b874896ce..cac15a8ec4 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.93.0 +version: 0.94.0 core: | Display help information about different parts of Nushell. usage: | @@ -59,11 +59,11 @@ search for string in command names, usage and search terms ## Subcommands: -| name | type | usage | -| ---------------------------------------------------- | ------- | ------------------------------------ | -| [`help aliases`](/commands/docs/help_aliases.md) | Builtin | Show help on nushell aliases. | -| [`help commands`](/commands/docs/help_commands.md) | Builtin | Show help on nushell commands. | -| [`help escapes`](/commands/docs/help_escapes.md) | Builtin | Show help on nushell string escapes. | -| [`help externs`](/commands/docs/help_externs.md) | Builtin | Show help on nushell externs. | -| [`help modules`](/commands/docs/help_modules.md) | Builtin | Show help on nushell modules. | -| [`help operators`](/commands/docs/help_operators.md) | Builtin | Show help on nushell operators. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------------- | ------------------------------------ | -------- | +| [`help aliases`](/commands/docs/help_aliases.md) | Show help on nushell aliases. | built-in | +| [`help commands`](/commands/docs/help_commands.md) | Show help on nushell commands. | built-in | +| [`help escapes`](/commands/docs/help_escapes.md) | Show help on nushell string escapes. | built-in | +| [`help externs`](/commands/docs/help_externs.md) | Show help on nushell externs. | built-in | +| [`help modules`](/commands/docs/help_modules.md) | Show help on nushell modules. | built-in | +| [`help operators`](/commands/docs/help_operators.md) | Show help on nushell operators. | built-in | \ No newline at end of file diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index 2e40d9d016..4d36ba4b22 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.93.0 +version: 0.94.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index d3d703db06..409a3dc033 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.93.0 +version: 0.94.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index d19a04ed37..3f9614f2bd 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.93.0 +version: 0.94.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index fa3ac5a6cf..b9bdead77e 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.93.0 +version: 0.94.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index c90007aa0a..b8e4a2ee0f 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.93.0 +version: 0.94.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 37b6106ce1..1db41288cc 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.93.0 +version: 0.94.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index a6f5a54483..4eb904a7b3 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.93.0 +version: 0.94.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 72be81b690..8a9cb03708 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.93.0 +version: 0.94.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index db26c65901..e26908c4f8 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.93.0 +version: 0.94.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | @@ -52,12 +52,12 @@ Compute a histogram for the types of files, with frequency column named freq Compute a histogram for a list of numbers ```nu > [1 2 1] | histogram -╭───┬───────┬───────┬──────────┬────────────┬────────────────────────────────────────────────────────────────────╮ -│ # │ value │ count │ quantile │ percentage │ frequency │ -├───┼───────┼───────┼──────────┼────────────┼────────────────────────────────────────────────────────────────────┤ -│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │ -│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │ -╰───┴───────┴───────┴──────────┴────────────┴────────────────────────────────────────────────────────────────────╯ +╭────┬────────┬────────┬───────────┬─────────────┬────────────────────────────────────────────────────────────────────╮ +│ # │ value │ count │ quantile │ percentage │ frequency │ +├────┼────────┼────────┼───────────┼─────────────┼────────────────────────────────────────────────────────────────────┤ +│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │ +│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │ +╰────┴────────┴────────┴───────────┴─────────────┴────────────────────────────────────────────────────────────────────╯ ``` diff --git a/commands/docs/history.md b/commands/docs/history.md index 6452fa14ab..a54cf30b97 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.93.0 +version: 0.94.0 history: | Get the command history. usage: | @@ -54,6 +54,6 @@ Search all the commands from history that contains 'cargo' ## Subcommands: -| name | type | usage | -| ------------------------------------------------------ | ------- | -------------------------------- | -| [`history session`](/commands/docs/history_session.md) | Builtin | Get the command history session. | +| name | usage | type | +| ------------------------------------------------------ | -------------------------------- | -------- | +| [`history session`](/commands/docs/history_session.md) | Get the command history session. | built-in | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 55b2f5789d..192cd1983d 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.93.0 +version: 0.94.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index f1060dbc25..2d277e7462 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.93.0 +version: 0.94.0 network: | Various commands for working with http methods. usage: | @@ -31,12 +31,12 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | --------------------------------------------------------- | -| [`http delete`](/commands/docs/http_delete.md) | Builtin | Delete the specified resource. | -| [`http get`](/commands/docs/http_get.md) | Builtin | Fetch the contents from a URL. | -| [`http head`](/commands/docs/http_head.md) | Builtin | Get the headers from a URL. | -| [`http options`](/commands/docs/http_options.md) | Builtin | Requests permitted communication options for a given URL. | -| [`http patch`](/commands/docs/http_patch.md) | Builtin | Patch a body to a URL. | -| [`http post`](/commands/docs/http_post.md) | Builtin | Post a body to a URL. | -| [`http put`](/commands/docs/http_put.md) | Builtin | Put a body to a URL. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------ | --------------------------------------------------------- | -------- | +| [`http delete`](/commands/docs/http_delete.md) | Delete the specified resource. | built-in | +| [`http get`](/commands/docs/http_get.md) | Fetch the contents from a URL. | built-in | +| [`http head`](/commands/docs/http_head.md) | Get the headers from a URL. | built-in | +| [`http options`](/commands/docs/http_options.md) | Requests permitted communication options for a given URL. | built-in | +| [`http patch`](/commands/docs/http_patch.md) | Patch a body to a URL. | built-in | +| [`http post`](/commands/docs/http_post.md) | Post a body to a URL. | built-in | +| [`http put`](/commands/docs/http_put.md) | Put a body to a URL. | built-in | \ No newline at end of file diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 712d9933f7..a9aa7543bc 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.93.0 +version: 0.94.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index fe1efc7fc2..2fea110d0a 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.93.0 +version: 0.94.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 5416750c71..016030a07f 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.93.0 +version: 0.94.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index d4b34de20a..0dc33833e8 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.93.0 +version: 0.94.0 network: | Requests permitted communication options for a given URL. usage: | diff --git a/commands/docs/http_patch.md b/commands/docs/http_patch.md index 884e3b3b19..c5e6875483 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.93.0 +version: 0.94.0 network: | Patch a body to a URL. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 981fcb9e1c..9195518669 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.93.0 +version: 0.94.0 network: | Post a body to a URL. usage: | diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 6f4274de76..044d57f8e7 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.93.0 +version: 0.94.0 network: | Put a body to a URL. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index d006cb0d33..ae4068edb3 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.93.0 +version: 0.94.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 265ee31944..84222ed049 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.93.0 +version: 0.94.0 core: | Ignore the output of the previous command in the pipeline. usage: | diff --git a/commands/docs/inc.md b/commands/docs/inc.md index 6ab8224d5e..8f5bfcfef1 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.93.0 +version: 0.94.0 default: | Increment a value or version. Optionally use the column of a table. usage: | diff --git a/commands/docs/input.md b/commands/docs/input.md index 66b41aef4a..69a9574558 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Get input from the user. usage: | @@ -53,7 +53,7 @@ Get two characters from the user, and assign to a variable ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | -------------------------------- | -| [`input list`](/commands/docs/input_list.md) | Builtin | Interactive list selection. | -| [`input listen`](/commands/docs/input_listen.md) | Builtin | Listen for user interface event. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------ | -------------------------------- | -------- | +| [`input list`](/commands/docs/input_list.md) | Interactive list selection. | built-in | +| [`input listen`](/commands/docs/input_listen.md) | Listen for user interface event. | built-in | \ No newline at end of file diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index a4221cd2e4..a136e1eab0 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index f0a9b7368b..7b46419e86 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 17c8c0e298..6014e072bd 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Insert a new column, using an expression or closure to create each row's values. usage: | diff --git a/commands/docs/inspect.md b/commands/docs/inspect.md index 14686b3347..1df2efca4c 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 9a7ad5f8a0..d744e813b7 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Read multiple streams in parallel and combine them into one stream. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index 5d3181c843..3fd60fa8fd 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Commands to convert data from one type to another. usage: | @@ -31,19 +31,19 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------------- | ------- | ------------------------------------------ | -| [`into binary`](/commands/docs/into_binary.md) | Builtin | Convert value to a binary primitive. | -| [`into bits`](/commands/docs/into_bits.md) | Builtin | Convert value to a binary primitive. | -| [`into bool`](/commands/docs/into_bool.md) | Builtin | Convert value to boolean. | -| [`into cell-path`](/commands/docs/into_cell-path.md) | Builtin | Convert value to a cell-path. | -| [`into datetime`](/commands/docs/into_datetime.md) | Builtin | Convert text or timestamp into a datetime. | -| [`into duration`](/commands/docs/into_duration.md) | Builtin | Convert value to duration. | -| [`into filesize`](/commands/docs/into_filesize.md) | Builtin | Convert value to filesize. | -| [`into float`](/commands/docs/into_float.md) | Builtin | Convert data into floating point number. | -| [`into glob`](/commands/docs/into_glob.md) | Builtin | Convert value to glob. | -| [`into int`](/commands/docs/into_int.md) | Builtin | Convert value to integer. | -| [`into record`](/commands/docs/into_record.md) | Builtin | Convert value to record. | -| [`into sqlite`](/commands/docs/into_sqlite.md) | Builtin | Convert table into a SQLite database. | -| [`into string`](/commands/docs/into_string.md) | Builtin | Convert value to string. | -| [`into value`](/commands/docs/into_value.md) | Builtin | Infer nushell datatype for each cell. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------------- | ------------------------------------------ | -------- | +| [`into binary`](/commands/docs/into_binary.md) | Convert value to a binary primitive. | built-in | +| [`into bits`](/commands/docs/into_bits.md) | Convert value to a binary primitive. | built-in | +| [`into bool`](/commands/docs/into_bool.md) | Convert value to boolean. | built-in | +| [`into cell-path`](/commands/docs/into_cell-path.md) | Convert value to a cell-path. | built-in | +| [`into datetime`](/commands/docs/into_datetime.md) | Convert text or timestamp into a datetime. | built-in | +| [`into duration`](/commands/docs/into_duration.md) | Convert value to duration. | built-in | +| [`into filesize`](/commands/docs/into_filesize.md) | Convert value to filesize. | built-in | +| [`into float`](/commands/docs/into_float.md) | Convert data into floating point number. | built-in | +| [`into glob`](/commands/docs/into_glob.md) | Convert value to glob. | built-in | +| [`into int`](/commands/docs/into_int.md) | Convert value to integer. | built-in | +| [`into record`](/commands/docs/into_record.md) | Convert value to record. | built-in | +| [`into sqlite`](/commands/docs/into_sqlite.md) | Convert table into a SQLite database. | built-in | +| [`into string`](/commands/docs/into_string.md) | Convert value to string. | built-in | +| [`into value`](/commands/docs/into_value.md) | Infer nushell datatype for each cell. | built-in | \ No newline at end of file diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index a1a926be2b..5bb39ecde7 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index cf895a6010..2891138d4f 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 94730b87bd..ca7c50e5da 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index 3083927941..ab750179f5 100644 --- a/commands/docs/into_cell-path.md +++ b/commands/docs/into_cell-path.md @@ -2,7 +2,7 @@ title: into cell-path categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index 626fe5799a..4cc69e6c17 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert text or timestamp into a datetime. usage: | @@ -76,11 +76,11 @@ Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago) Convert list of timestamps to datetimes ```nu > ["2023-03-30 10:10:07 -05:00", "2023-05-05 13:43:49 -05:00", "2023-06-05 01:37:42 -05:00"] | into datetime -╭───┬───────────────╮ -│ 0 │ a year ago │ -│ 1 │ a year ago │ -│ 2 │ 11 months ago │ -╰───┴───────────────╯ +╭───┬────────────╮ +│ 0 │ a year ago │ +│ 1 │ a year ago │ +│ 2 │ a year ago │ +╰───┴────────────╯ ``` diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index 4ececf6c7e..e95f26fc60 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 4bf18969f6..042fd7cbd4 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index 6ef502ca79..71dd45b76d 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index 344f22a70c..d6c767a5eb 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index 69164a9369..c5cda6f264 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index a7bd117eed..0a00c5715b 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to record. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index ba358d8c25..0e00c0e482 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 4265e68001..d7e4d2c020 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.93.0 +version: 0.94.0 conversions: | Convert value to string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 3913e07976..543835661d 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Infer nushell datatype for each cell. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 87e38f6a13..36c564df29 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.93.0 +version: 0.94.0 core: | Check if nushell is running with administrator or root privileges. usage: | diff --git a/commands/docs/is-empty.md b/commands/docs/is-empty.md index 6fdbd36741..2bb896ed6c 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 38027a8776..77dcaf44e9 100644 --- a/commands/docs/is-not-empty.md +++ b/commands/docs/is-not-empty.md @@ -2,7 +2,7 @@ title: is-not-empty categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index fbd8f59300..51c85a1aa0 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index c906fdd8b5..d030ee3d53 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Given a record, iterate on each pair of column name and associated value. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index 1966141313..465b592675 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index 23f6be0af9..1e94f38e3c 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Keybindings related commands. usage: | @@ -34,8 +34,8 @@ For more information on input and keybindings, check: ## Subcommands: -| name | type | usage | -| -------------------------------------------------------------- | ------- | -------------------------------------------------------------- | -| [`keybindings default`](/commands/docs/keybindings_default.md) | Builtin | List default keybindings. | -| [`keybindings list`](/commands/docs/keybindings_list.md) | Builtin | List available options that can be used to create keybindings. | -| [`keybindings listen`](/commands/docs/keybindings_listen.md) | Builtin | Get input from the user. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------- | +| [`keybindings default`](/commands/docs/keybindings_default.md) | List default keybindings. | built-in | +| [`keybindings list`](/commands/docs/keybindings_list.md) | List available options that can be used to create keybindings. | built-in | +| [`keybindings listen`](/commands/docs/keybindings_listen.md) | Get input from the user. | built-in | \ No newline at end of file diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index e706839cef..f8a66c0aef 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 09c06c1221..25752592c1 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | List available options that can be used to create keybindings. usage: | diff --git a/commands/docs/keybindings_listen.md b/commands/docs/keybindings_listen.md index 4325e12292..1740718007 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 8088d93083..fda15db169 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index c93c1be700..ec9789916a 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/lazy_make.md b/commands/docs/lazy_make.md deleted file mode 100644 index 89c8edde7c..0000000000 --- a/commands/docs/lazy_make.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: lazy make -categories: | - core -version: 0.93.0 -core: | - Create a lazy record. -usage: | - Create a lazy record. -feature: default ---- - - -# `lazy make` for [core](/commands/categories/core.md) - -
Create a lazy record.
- -## Signature - -```> lazy make {flags} ``` - -## Flags - - - `--columns, -c {list}`: Closure that gets called when the LazyRecord needs to list the available column names - - `--get-value, -g {closure(string)}`: Closure to call when a value needs to be produced on demand - - -## Input/output types: - -| input | output | -| ------- | ------ | -| nothing | record | - -## Examples - -Create a lazy record -```nu -> lazy make --columns ["haskell", "futures", "nushell"] --get-value { |lazything| $lazything + "!" } - -``` - -Test the laziness of lazy records -```nu -> lazy make --columns ["hello"] --get-value { |key| print $"getting ($key)!"; $key | str upcase } - -``` - -## Notes -Lazy records are special records that only evaluate their values once the property is requested. - For example, when printing a lazy record, all of its fields will be collected. But when accessing - a specific property, only it will be evaluated. - - Note that this is unrelated to the lazyframes feature bundled with dataframes. \ No newline at end of file diff --git a/commands/docs/length.md b/commands/docs/length.md index 132b0fea18..d9c5f12096 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Count the number of items in an input list or rows in a table. usage: | diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index 9a7319320e..e1f0020b11 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.93.0 +version: 0.94.0 removed: | `let-env FOO = ...` has been removed, use `$env.FOO = ...` instead. usage: | diff --git a/commands/docs/let.md b/commands/docs/let.md index 4daadf6044..a895d3b176 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.93.0 +version: 0.94.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index c4e1752eb6..0a46caa334 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 19cf1b4857..04673f1cde 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 051516d30c..5889d6f93f 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.93.0 +version: 0.94.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 1a6a7c27fe..3c6bd721bc 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | List the filenames, sizes, and modification times of items in a directory. usage: | diff --git a/commands/docs/match.md b/commands/docs/match.md index 4bade1e5c5..0320354959 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.93.0 +version: 0.94.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 89bba23139..3b815ea1c2 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.93.0 +version: 0.94.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | @@ -31,34 +31,34 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------- | -| [`math abs`](/commands/docs/math_abs.md) | Builtin | Returns the absolute value of a number. | -| [`math arccos`](/commands/docs/math_arccos.md) | Builtin | Returns the arccosine of the number. | -| [`math arccosh`](/commands/docs/math_arccosh.md) | Builtin | Returns the inverse of the hyperbolic cosine function. | -| [`math arcsin`](/commands/docs/math_arcsin.md) | Builtin | Returns the arcsine of the number. | -| [`math arcsinh`](/commands/docs/math_arcsinh.md) | Builtin | Returns the inverse of the hyperbolic sine function. | -| [`math arctan`](/commands/docs/math_arctan.md) | Builtin | Returns the arctangent of the number. | -| [`math arctanh`](/commands/docs/math_arctanh.md) | Builtin | Returns the inverse of the hyperbolic tangent function. | -| [`math avg`](/commands/docs/math_avg.md) | Builtin | Returns the average of a list of numbers. | -| [`math ceil`](/commands/docs/math_ceil.md) | Builtin | Returns the ceil of a number (smallest integer greater than or equal to that number). | -| [`math cos`](/commands/docs/math_cos.md) | Builtin | Returns the cosine of the number. | -| [`math cosh`](/commands/docs/math_cosh.md) | Builtin | Returns the hyperbolic cosine of the number. | -| [`math exp`](/commands/docs/math_exp.md) | Builtin | Returns e raised to the power of x. | -| [`math floor`](/commands/docs/math_floor.md) | Builtin | Returns the floor of a number (largest integer less than or equal to that number). | -| [`math ln`](/commands/docs/math_ln.md) | Builtin | Returns the natural logarithm. Base: (math e). | -| [`math log`](/commands/docs/math_log.md) | Builtin | Returns the logarithm for an arbitrary base. | -| [`math max`](/commands/docs/math_max.md) | Builtin | Returns the maximum of a list of values, or of columns in a table. | -| [`math median`](/commands/docs/math_median.md) | Builtin | Computes the median of a list of numbers. | -| [`math min`](/commands/docs/math_min.md) | Builtin | Finds the minimum within a list of values or tables. | -| [`math mode`](/commands/docs/math_mode.md) | Builtin | Returns the most frequent element(s) from a list of numbers or tables. | -| [`math product`](/commands/docs/math_product.md) | Builtin | Returns the product of a list of numbers or the products of each column of a table. | -| [`math round`](/commands/docs/math_round.md) | Builtin | Returns the input number rounded to the specified precision. | -| [`math sin`](/commands/docs/math_sin.md) | Builtin | Returns the sine of the number. | -| [`math sinh`](/commands/docs/math_sinh.md) | Builtin | Returns the hyperbolic sine of the number. | -| [`math sqrt`](/commands/docs/math_sqrt.md) | Builtin | Returns the square root of the input number. | -| [`math stddev`](/commands/docs/math_stddev.md) | Builtin | Returns the standard deviation of a list of numbers, or of each column in a table. | -| [`math sum`](/commands/docs/math_sum.md) | Builtin | Returns the sum of a list of numbers or of each column in a table. | -| [`math tan`](/commands/docs/math_tan.md) | Builtin | Returns the tangent of the number. | -| [`math tanh`](/commands/docs/math_tanh.md) | Builtin | Returns the hyperbolic tangent of the number. | -| [`math variance`](/commands/docs/math_variance.md) | Builtin | Returns the variance of a list of numbers or of each column in a table. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | +| [`math abs`](/commands/docs/math_abs.md) | Returns the absolute value of a number. | built-in | +| [`math arccos`](/commands/docs/math_arccos.md) | Returns the arccosine of the number. | built-in | +| [`math arccosh`](/commands/docs/math_arccosh.md) | Returns the inverse of the hyperbolic cosine function. | built-in | +| [`math arcsin`](/commands/docs/math_arcsin.md) | Returns the arcsine of the number. | built-in | +| [`math arcsinh`](/commands/docs/math_arcsinh.md) | Returns the inverse of the hyperbolic sine function. | built-in | +| [`math arctan`](/commands/docs/math_arctan.md) | Returns the arctangent of the number. | built-in | +| [`math arctanh`](/commands/docs/math_arctanh.md) | Returns the inverse of the hyperbolic tangent function. | built-in | +| [`math avg`](/commands/docs/math_avg.md) | Returns the average of a list of numbers. | built-in | +| [`math ceil`](/commands/docs/math_ceil.md) | Returns the ceil of a number (smallest integer greater than or equal to that number). | built-in | +| [`math cos`](/commands/docs/math_cos.md) | Returns the cosine of the number. | built-in | +| [`math cosh`](/commands/docs/math_cosh.md) | Returns the hyperbolic cosine of the number. | built-in | +| [`math exp`](/commands/docs/math_exp.md) | Returns e raised to the power of x. | built-in | +| [`math floor`](/commands/docs/math_floor.md) | Returns the floor of a number (largest integer less than or equal to that number). | built-in | +| [`math ln`](/commands/docs/math_ln.md) | Returns the natural logarithm. Base: (math e). | built-in | +| [`math log`](/commands/docs/math_log.md) | Returns the logarithm for an arbitrary base. | built-in | +| [`math max`](/commands/docs/math_max.md) | Returns the maximum of a list of values, or of columns in a table. | built-in | +| [`math median`](/commands/docs/math_median.md) | Computes the median of a list of numbers. | built-in | +| [`math min`](/commands/docs/math_min.md) | Finds the minimum within a list of values or tables. | built-in | +| [`math mode`](/commands/docs/math_mode.md) | Returns the most frequent element(s) from a list of numbers or tables. | built-in | +| [`math product`](/commands/docs/math_product.md) | Returns the product of a list of numbers or the products of each column of a table. | built-in | +| [`math round`](/commands/docs/math_round.md) | Returns the input number rounded to the specified precision. | built-in | +| [`math sin`](/commands/docs/math_sin.md) | Returns the sine of the number. | built-in | +| [`math sinh`](/commands/docs/math_sinh.md) | Returns the hyperbolic sine of the number. | built-in | +| [`math sqrt`](/commands/docs/math_sqrt.md) | Returns the square root of the input number. | built-in | +| [`math stddev`](/commands/docs/math_stddev.md) | Returns the standard deviation of a list of numbers, or of each column in a table. | built-in | +| [`math sum`](/commands/docs/math_sum.md) | Returns the sum of a list of numbers or of each column in a table. | built-in | +| [`math tan`](/commands/docs/math_tan.md) | Returns the tangent of the number. | built-in | +| [`math tanh`](/commands/docs/math_tanh.md) | Returns the hyperbolic tangent of the number. | built-in | +| [`math variance`](/commands/docs/math_variance.md) | Returns the variance of a list of numbers or of each column in a table. | built-in | \ No newline at end of file diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index 06893dce5c..ad648bb65f 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the absolute value of a number. usage: | diff --git a/commands/docs/math_arccos.md b/commands/docs/math_arccos.md index 2e0a30aacf..76c2e340e5 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 083a4fb670..3962e0209d 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index 0e770e81c4..fdd45b374e 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index 74df692f69..b85bf13cd1 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the inverse of the hyperbolic sine function. usage: | diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index a1e3e75cad..7c00c9779e 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 3df8c97354..3d989e10ff 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index 3b3f12e543..d7cc268080 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the average of a list of numbers. usage: | diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index 33ed78b927..cabdc407a4 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the ceil of a number (smallest integer greater than or equal to that number). usage: | diff --git a/commands/docs/math_cos.md b/commands/docs/math_cos.md index 241f451e93..c45e4e4cea 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 4e6082a933..fe26b718e4 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index 23f1eb9dc9..97027a3207 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns e raised to the power of x. usage: | diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index 91fc53ed8e..b960d39698 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the floor of a number (largest integer less than or equal to that number). usage: | diff --git a/commands/docs/math_ln.md b/commands/docs/math_ln.md index 9d9065fbbc..2fddf1fbc3 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index 6b13f96f80..9a23ce9c44 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index 30c3ae0bd4..ca29c6bcd0 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the maximum of a list of values, or of columns in a table. usage: | diff --git a/commands/docs/math_median.md b/commands/docs/math_median.md index 55ea4e0139..00458fa6a9 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.93.0 +version: 0.94.0 math: | Computes the median of a list of numbers. usage: | diff --git a/commands/docs/math_min.md b/commands/docs/math_min.md index f981fc71de..6e3c509b9a 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.93.0 +version: 0.94.0 math: | Finds the minimum within a list of values or tables. usage: | diff --git a/commands/docs/math_mode.md b/commands/docs/math_mode.md index b5af4970c3..da024e575b 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the most frequent element(s) from a list of numbers or tables. usage: | diff --git a/commands/docs/math_product.md b/commands/docs/math_product.md index 66537e92f3..ab776d951f 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the product of a list of numbers or the products of each column of a table. usage: | diff --git a/commands/docs/math_round.md b/commands/docs/math_round.md index 6d2dec979e..fc40183d58 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the input number rounded to the specified precision. usage: | diff --git a/commands/docs/math_sin.md b/commands/docs/math_sin.md index f8d92eba6e..771dbd99db 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 769fca4467..12b738dad4 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 08873b6318..c7289ed0fa 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the square root of the input number. usage: | diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index 0b834a98ee..284dc1417e 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the standard deviation of a list of numbers, or of each column in a table. usage: | diff --git a/commands/docs/math_sum.md b/commands/docs/math_sum.md index 6c40dfdd19..2b553a7a94 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the sum of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/math_tan.md b/commands/docs/math_tan.md index f4eab7a109..f6aab294ec 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 160f16cf83..c008c2d12c 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index ca2f2c0d84..7501b0bc6e 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.93.0 +version: 0.94.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 8c68f7a674..f7195b2a83 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index d0ea53875f..5ecd150341 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Get the metadata for items in the stream. usage: | @@ -47,6 +47,6 @@ Get the metadata of the input ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | ----------------------------------------- | -| [`metadata set`](/commands/docs/metadata_set.md) | Builtin | Set the metadata for items in the stream. | +| name | usage | type | +| ------------------------------------------------ | ----------------------------------------- | -------- | +| [`metadata set`](/commands/docs/metadata_set.md) | Set the metadata for items in the stream. | built-in | diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index e602a9c818..7792de3b72 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Set the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index d6021c6446..1a2f0b202a 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 8d8a7081db..a8be0e0c58 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index 5e3abd4afd..04c0048e62 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.93.0 +version: 0.94.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 8e0c95a94b..9f58b9ea3d 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index 88446edbe0..2a6028db59 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.93.0 +version: 0.94.0 core: | Create a mutable variable and give it a value. usage: | diff --git a/commands/docs/mv.md b/commands/docs/mv.md index 8d66dc150c..5294448f16 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | diff --git a/commands/docs/n.md b/commands/docs/n.md index 37922ac64e..2f07bba1e7 100644 --- a/commands/docs/n.md +++ b/commands/docs/n.md @@ -2,7 +2,7 @@ title: n categories: | shells -version: 0.92.0 +version: 0.94.0 shells: | Switch to the next shell. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 4bebe45625..325b3bb054 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Validate and parse input content. usage: | @@ -55,7 +55,7 @@ Parse a input file by showing error message ``` -Parse an external stream as script by showing error message +Parse a byte stream as script by showing error message ```nu > open foo.nu | nu-check --debug script.nu diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 36f0e1c49b..6c08be903e 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 73d5bb6344..b588a3ce05 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). usage: | diff --git a/commands/docs/overlay.md b/commands/docs/overlay.md index 3314fa684c..4c3f750638 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.93.0 +version: 0.94.0 core: | Commands for manipulating overlays. usage: | @@ -34,9 +34,9 @@ This command is a parser keyword. For details, check: ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | -------------------------------------------- | -| [`overlay hide`](/commands/docs/overlay_hide.md) | Builtin | Hide an active overlay. | -| [`overlay list`](/commands/docs/overlay_list.md) | Builtin | List all active overlays. | -| [`overlay new`](/commands/docs/overlay_new.md) | Builtin | Create an empty overlay. | -| [`overlay use`](/commands/docs/overlay_use.md) | Builtin | Use definitions from a module as an overlay. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------ | -------------------------------------------- | -------- | +| [`overlay hide`](/commands/docs/overlay_hide.md) | Hide an active overlay. | keyword | +| [`overlay list`](/commands/docs/overlay_list.md) | List all active overlays. | built-in | +| [`overlay new`](/commands/docs/overlay_new.md) | Create an empty overlay. | keyword | +| [`overlay use`](/commands/docs/overlay_use.md) | Use definitions from a module as an overlay. | keyword | \ No newline at end of file diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 7626abf93e..643bc19724 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.93.0 +version: 0.94.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index a4613618b4..2bdc5d4448 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.93.0 +version: 0.94.0 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 9c97c9381b..1d84b3a8c8 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.93.0 +version: 0.94.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index cd7ec0d33a..8f81b1ced3 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.93.0 +version: 0.94.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/p.md b/commands/docs/p.md index 6ba96a99d0..d6e6f2fede 100644 --- a/commands/docs/p.md +++ b/commands/docs/p.md @@ -2,7 +2,7 @@ title: p categories: | shells -version: 0.92.0 +version: 0.94.0 shells: | Switch to the previous shell. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index 8c8afdb2d6..b5d294df5a 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | experimental -version: 0.93.0 +version: 0.94.0 experimental: | Executes a rust panic, useful only for testing. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index a006c5733c..2faec95410 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 2b6738d1df..a577e1752f 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Parse columns from string data using a simple pattern. usage: | diff --git a/commands/docs/path.md b/commands/docs/path.md index 37d2a3ac28..e5d8389733 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.93.0 +version: 0.94.0 path: | Explore and manipulate paths. usage: | @@ -44,14 +44,14 @@ the path literal. ## Subcommands: -| name | type | usage | -| -------------------------------------------------------- | ------- | ----------------------------------------------------------------------- | -| [`path basename`](/commands/docs/path_basename.md) | Builtin | Get the final component of a path. | -| [`path dirname`](/commands/docs/path_dirname.md) | Builtin | Get the parent directory of a path. | -| [`path exists`](/commands/docs/path_exists.md) | Builtin | Check whether a path exists. | -| [`path expand`](/commands/docs/path_expand.md) | Builtin | Try to expand a path to its absolute form. | -| [`path join`](/commands/docs/path_join.md) | Builtin | Join a structured path or a list of path parts. | -| [`path parse`](/commands/docs/path_parse.md) | Builtin | Convert a path into structured data. | -| [`path relative-to`](/commands/docs/path_relative-to.md) | Builtin | Express a path as relative to another path. | -| [`path split`](/commands/docs/path_split.md) | Builtin | Split a path into a list based on the system's path separator. | -| [`path type`](/commands/docs/path_type.md) | Builtin | Get the type of the object a path refers to (e.g., file, dir, symlink). | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------------- | ----------------------------------------------------------------------- | -------- | +| [`path basename`](/commands/docs/path_basename.md) | Get the final component of a path. | built-in | +| [`path dirname`](/commands/docs/path_dirname.md) | Get the parent directory of a path. | built-in | +| [`path exists`](/commands/docs/path_exists.md) | Check whether a path exists. | built-in | +| [`path expand`](/commands/docs/path_expand.md) | Try to expand a path to its absolute form. | built-in | +| [`path join`](/commands/docs/path_join.md) | Join a structured path or a list of path parts. | built-in | +| [`path parse`](/commands/docs/path_parse.md) | Convert a path into structured data. | built-in | +| [`path relative-to`](/commands/docs/path_relative-to.md) | Express a path as relative to another path. | built-in | +| [`path split`](/commands/docs/path_split.md) | Split a path into a list based on the system's path separator. | built-in | +| [`path type`](/commands/docs/path_type.md) | Get the type of the object a path refers to (e.g., file, dir, symlink). | built-in | \ No newline at end of file diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 052f6a7f34..2da176ef56 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.93.0 +version: 0.94.0 path: | Get the final component of a path. usage: | diff --git a/commands/docs/path_dirname.md b/commands/docs/path_dirname.md index 3381351bce..078b2f5c85 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.93.0 +version: 0.94.0 path: | Get the parent directory of a path. usage: | diff --git a/commands/docs/path_exists.md b/commands/docs/path_exists.md index 45cb91e3f9..2ccf2201ae 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.93.0 +version: 0.94.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 2faba6d310..93143aa86d 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.93.0 +version: 0.94.0 path: | Try to expand a path to its absolute form. usage: | diff --git a/commands/docs/path_join.md b/commands/docs/path_join.md index 86aa4ffca8..ba52e78df6 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.93.0 +version: 0.94.0 path: | Join a structured path or a list of path parts. usage: | diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index 7b8487de1d..87262a9328 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.93.0 +version: 0.94.0 path: | Convert a path into structured data. usage: | diff --git a/commands/docs/path_relative-to.md b/commands/docs/path_relative-to.md index b26af439fb..b56e88c8a4 100644 --- a/commands/docs/path_relative-to.md +++ b/commands/docs/path_relative-to.md @@ -2,7 +2,7 @@ title: path relative-to categories: | path -version: 0.93.0 +version: 0.94.0 path: | Express a path as relative to another path. usage: | diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index fb02ae257f..a4a7858c36 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.93.0 +version: 0.94.0 path: | Split a path into a list based on the system's path separator. usage: | diff --git a/commands/docs/path_type.md b/commands/docs/path_type.md index 15246e3527..e50bb04d97 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.93.0 +version: 0.94.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index 1edaf105f3..85a013ee3d 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | Commands for managing plugins. usage: | @@ -63,10 +63,10 @@ Remove the installed signatures for the `inc` plugin. ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | ------------------------------------------------------- | -| [`plugin add`](/commands/docs/plugin_add.md) | Builtin | Add a plugin to the plugin registry file. | -| [`plugin list`](/commands/docs/plugin_list.md) | Builtin | List installed plugins. | -| [`plugin rm`](/commands/docs/plugin_rm.md) | Builtin | Remove a plugin from the plugin registry file. | -| [`plugin stop`](/commands/docs/plugin_stop.md) | Builtin | Stop an installed plugin if it was running. | -| [`plugin use`](/commands/docs/plugin_use.md) | Builtin | Load a plugin from the plugin registry file into scope. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------- | ------------------------------------------------------- | -------- | +| [`plugin add`](/commands/docs/plugin_add.md) | Add a plugin to the plugin registry file. | built-in | +| [`plugin list`](/commands/docs/plugin_list.md) | List installed plugins. | built-in | +| [`plugin rm`](/commands/docs/plugin_rm.md) | Remove a plugin from the plugin registry file. | built-in | +| [`plugin stop`](/commands/docs/plugin_stop.md) | Stop an installed plugin if it was running. | built-in | +| [`plugin use`](/commands/docs/plugin_use.md) | Load a plugin from the plugin registry file into scope. | keyword | \ No newline at end of file diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 150b0cad5b..8872758621 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | Add a plugin to the plugin registry file. usage: | @@ -50,7 +50,8 @@ Run the `nu_plugin_polars` plugin from the current directory or $env.NU_PLUGIN_D ``` ## Notes -This does not load the plugin commands into the scope - see `register` for that. +This does not load the plugin commands into the scope - see `plugin use` for +that. Instead, it runs the plugin to get its command signatures, and then edits the plugin registry file (by default, `$nu.plugin-path`). The changes will be diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index fabfaa8281..924e64f96e 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | List installed plugins. usage: | diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index b8587ac1b0..00c28c93cb 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | Remove a plugin from the plugin registry file. usage: | diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index 2bb08286eb..316f16a543 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | Stop an installed plugin if it was running. usage: | diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index e338be7f06..186ade6279 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | Load a plugin from the plugin registry file into scope. usage: | diff --git a/commands/docs/polars.md b/commands/docs/polars.md index d19d3282ac..67bb19f52a 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -31,115 +31,115 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| -------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------ | -| [`polars agg`](/commands/docs/polars_agg.md) | Builtin,Plugin | Performs a series of aggregations from a group-by. | -| [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Builtin,Plugin | Creates an agg_groups expression. | -| [`polars all-false`](/commands/docs/polars_all-false.md) | Builtin,Plugin | Returns true if all values are false. | -| [`polars all-true`](/commands/docs/polars_all-true.md) | Builtin,Plugin | Returns true if all values are true. | -| [`polars append`](/commands/docs/polars_append.md) | Builtin,Plugin | Appends a new dataframe. | -| [`polars arg-max`](/commands/docs/polars_arg-max.md) | Builtin,Plugin | Return index for max value in series. | -| [`polars arg-min`](/commands/docs/polars_arg-min.md) | Builtin,Plugin | Return index for min value in series. | -| [`polars arg-sort`](/commands/docs/polars_arg-sort.md) | Builtin,Plugin | Returns indexes for a sorted series. | -| [`polars arg-true`](/commands/docs/polars_arg-true.md) | Builtin,Plugin | Returns indexes where values are true. | -| [`polars arg-unique`](/commands/docs/polars_arg-unique.md) | Builtin,Plugin | Returns indexes for unique values. | -| [`polars arg-where`](/commands/docs/polars_arg-where.md) | Builtin,Plugin | Creates an expression that returns the arguments where expression is true. | -| [`polars as`](/commands/docs/polars_as.md) | Builtin,Plugin | Creates an alias expression. | -| [`polars as-date`](/commands/docs/polars_as-date.md) | Builtin,Plugin | Converts string to date. | -| [`polars as-datetime`](/commands/docs/polars_as-datetime.md) | Builtin,Plugin | Converts string to datetime. | -| [`polars cache`](/commands/docs/polars_cache.md) | Builtin,Plugin | Caches operations in a new LazyFrame. | -| [`polars cast`](/commands/docs/polars_cast.md) | Builtin,Plugin | Cast a column to a different dtype. | -| [`polars col`](/commands/docs/polars_col.md) | Builtin,Plugin | Creates a named column expression. | -| [`polars collect`](/commands/docs/polars_collect.md) | Builtin,Plugin | Collect lazy dataframe into eager dataframe. | -| [`polars columns`](/commands/docs/polars_columns.md) | Builtin,Plugin | Show dataframe columns. | -| [`polars concat-str`](/commands/docs/polars_concat-str.md) | Builtin,Plugin | Creates a concat string expression. | -| [`polars concatenate`](/commands/docs/polars_concatenate.md) | Builtin,Plugin | Concatenates strings with other array. | -| [`polars contains`](/commands/docs/polars_contains.md) | Builtin,Plugin | Checks if a pattern is contained in a string. | -| [`polars count`](/commands/docs/polars_count.md) | Builtin,Plugin | Creates a count expression. | -| [`polars count-null`](/commands/docs/polars_count-null.md) | Builtin,Plugin | Counts null values. | -| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Builtin,Plugin | Cumulative calculation for a series. | -| [`polars datepart`](/commands/docs/polars_datepart.md) | Builtin,Plugin | Creates an expression for capturing the specified datepart in a column. | -| [`polars drop`](/commands/docs/polars_drop.md) | Builtin,Plugin | Creates a new dataframe by dropping the selected columns. | -| [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Builtin,Plugin | Drops duplicate values in dataframe. | -| [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Builtin,Plugin | Drops null values in dataframe. | -| [`polars dummies`](/commands/docs/polars_dummies.md) | Builtin,Plugin | Creates a new dataframe with dummy variables. | -| [`polars explode`](/commands/docs/polars_explode.md) | Builtin,Plugin | Explodes a dataframe or creates a explode expression. | -| [`polars expr-not`](/commands/docs/polars_expr-not.md) | Builtin,Plugin | Creates a not expression. | -| [`polars fetch`](/commands/docs/polars_fetch.md) | Builtin,Plugin | Collects the lazyframe to the selected rows. | -| [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Builtin,Plugin | Replaces NaN values with the given expression. | -| [`polars fill-null`](/commands/docs/polars_fill-null.md) | Builtin,Plugin | Replaces NULL values with the given expression. | -| [`polars filter`](/commands/docs/polars_filter.md) | Builtin,Plugin | Filter dataframe based in expression. | -| [`polars filter-with`](/commands/docs/polars_filter-with.md) | Builtin,Plugin | Filters dataframe using a mask or expression as reference. | -| [`polars first`](/commands/docs/polars_first.md) | Builtin,Plugin | Show only the first number of rows or create a first expression | -| [`polars flatten`](/commands/docs/polars_flatten.md) | Builtin,Plugin | An alias for polars explode. | -| [`polars get`](/commands/docs/polars_get.md) | Builtin,Plugin | Creates dataframe with the selected columns. | -| [`polars get-day`](/commands/docs/polars_get-day.md) | Builtin,Plugin | Gets day from date. | -| [`polars get-hour`](/commands/docs/polars_get-hour.md) | Builtin,Plugin | Gets hour from date. | -| [`polars get-minute`](/commands/docs/polars_get-minute.md) | Builtin,Plugin | Gets minute from date. | -| [`polars get-month`](/commands/docs/polars_get-month.md) | Builtin,Plugin | Gets month from date. | -| [`polars get-nanosecond`](/commands/docs/polars_get-nanosecond.md) | Builtin,Plugin | Gets nanosecond from date. | -| [`polars get-ordinal`](/commands/docs/polars_get-ordinal.md) | Builtin,Plugin | Gets ordinal from date. | -| [`polars get-second`](/commands/docs/polars_get-second.md) | Builtin,Plugin | Gets second from date. | -| [`polars get-week`](/commands/docs/polars_get-week.md) | Builtin,Plugin | Gets week from date. | -| [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Builtin,Plugin | Gets weekday from date. | -| [`polars get-year`](/commands/docs/polars_get-year.md) | Builtin,Plugin | Gets year from date. | -| [`polars group-by`](/commands/docs/polars_group-by.md) | Builtin,Plugin | Creates a group-by object that can be used for other aggregations. | -| [`polars implode`](/commands/docs/polars_implode.md) | Builtin,Plugin | Aggregates a group to a Series. | -| [`polars into-df`](/commands/docs/polars_into-df.md) | Builtin,Plugin | Converts a list, table or record into a dataframe. | -| [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Builtin,Plugin | Converts a dataframe into a lazy dataframe. | -| [`polars into-nu`](/commands/docs/polars_into-nu.md) | Builtin,Plugin | Converts a dataframe or an expression into into nushell value for access and exploration. | -| [`polars is-duplicated`](/commands/docs/polars_is-duplicated.md) | Builtin,Plugin | Creates mask indicating duplicated values. | -| [`polars is-in`](/commands/docs/polars_is-in.md) | Builtin,Plugin | Creates an is-in expression or checks to see if the elements are contained in the right series | -| [`polars is-not-null`](/commands/docs/polars_is-not-null.md) | Builtin,Plugin | Creates mask where value is not null. | -| [`polars is-null`](/commands/docs/polars_is-null.md) | Builtin,Plugin | Creates mask where value is null. | -| [`polars is-unique`](/commands/docs/polars_is-unique.md) | Builtin,Plugin | Creates mask indicating unique values. | -| [`polars join`](/commands/docs/polars_join.md) | Builtin,Plugin | Joins a lazy frame with other lazy frame. | -| [`polars last`](/commands/docs/polars_last.md) | Builtin,Plugin | Creates new dataframe with tail rows or creates a last expression. | -| [`polars lit`](/commands/docs/polars_lit.md) | Builtin,Plugin | Creates a literal expression. | -| [`polars lowercase`](/commands/docs/polars_lowercase.md) | Builtin,Plugin | Lowercase the strings in the column. | -| [`polars max`](/commands/docs/polars_max.md) | Builtin,Plugin | Creates a max expression or aggregates columns to their max value. | -| [`polars mean`](/commands/docs/polars_mean.md) | Builtin,Plugin | Creates a mean expression for an aggregation or aggregates columns to their mean value. | -| [`polars median`](/commands/docs/polars_median.md) | Builtin,Plugin | Median value from columns in a dataframe or creates expression for an aggregation | -| [`polars melt`](/commands/docs/polars_melt.md) | Builtin,Plugin | Unpivot a DataFrame from wide to long format. | -| [`polars min`](/commands/docs/polars_min.md) | Builtin,Plugin | Creates a min expression or aggregates columns to their min value. | -| [`polars n-unique`](/commands/docs/polars_n-unique.md) | Builtin,Plugin | Counts unique values. | -| [`polars not`](/commands/docs/polars_not.md) | Builtin,Plugin | Inverts boolean mask. | -| [`polars open`](/commands/docs/polars_open.md) | Builtin,Plugin | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. | -| [`polars otherwise`](/commands/docs/polars_otherwise.md) | Builtin,Plugin | Completes a when expression. | -| [`polars quantile`](/commands/docs/polars_quantile.md) | Builtin,Plugin | Aggregates the columns to the selected quantile. | -| [`polars query`](/commands/docs/polars_query.md) | Builtin,Plugin | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | -| [`polars rename`](/commands/docs/polars_rename.md) | Builtin,Plugin | Rename a dataframe column. | -| [`polars replace`](/commands/docs/polars_replace.md) | Builtin,Plugin | Replace the leftmost (sub)string by a regex pattern. | -| [`polars replace-all`](/commands/docs/polars_replace-all.md) | Builtin,Plugin | Replace all (sub)strings by a regex pattern. | -| [`polars reverse`](/commands/docs/polars_reverse.md) | Builtin,Plugin | Reverses the LazyFrame | -| [`polars rolling`](/commands/docs/polars_rolling.md) | Builtin,Plugin | Rolling calculation for a series. | -| [`polars sample`](/commands/docs/polars_sample.md) | Builtin,Plugin | Create sample dataframe. | -| [`polars schema`](/commands/docs/polars_schema.md) | Builtin,Plugin | Show schema for a dataframe. | -| [`polars select`](/commands/docs/polars_select.md) | Builtin,Plugin | Selects columns from lazyframe. | -| [`polars set`](/commands/docs/polars_set.md) | Builtin,Plugin | Sets value where given mask is true. | -| [`polars set-with-idx`](/commands/docs/polars_set-with-idx.md) | Builtin,Plugin | Sets value in the given index. | -| [`polars shape`](/commands/docs/polars_shape.md) | Builtin,Plugin | Shows column and row size for a dataframe. | -| [`polars shift`](/commands/docs/polars_shift.md) | Builtin,Plugin | Shifts the values by a given period. | -| [`polars slice`](/commands/docs/polars_slice.md) | Builtin,Plugin | Creates new dataframe from a slice of rows. | -| [`polars sort-by`](/commands/docs/polars_sort-by.md) | Builtin,Plugin | Sorts a lazy dataframe based on expression(s). | -| [`polars std`](/commands/docs/polars_std.md) | Builtin,Plugin | Creates a std expression for an aggregation of std value from columns in a dataframe. | -| [`polars store-get`](/commands/docs/polars_store-get.md) | Builtin,Plugin | Gets a Dataframe or other object from the plugin cache. | -| [`polars store-ls`](/commands/docs/polars_store-ls.md) | Builtin,Plugin | Lists stored dataframes. | -| [`polars store-rm`](/commands/docs/polars_store-rm.md) | Builtin,Plugin | Removes a stored Dataframe or other object from the plugin cache. | -| [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Builtin,Plugin | Get lengths of all strings. | -| [`polars str-slice`](/commands/docs/polars_str-slice.md) | Builtin,Plugin | Slices the string from the start position until the selected length. | -| [`polars strftime`](/commands/docs/polars_strftime.md) | Builtin,Plugin | Formats date based on string rule. | -| [`polars sum`](/commands/docs/polars_sum.md) | Builtin,Plugin | Creates a sum expression for an aggregation or aggregates columns to their sum value. | -| [`polars summary`](/commands/docs/polars_summary.md) | Builtin,Plugin | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | -| [`polars take`](/commands/docs/polars_take.md) | Builtin,Plugin | Creates new dataframe using the given indices. | -| [`polars to-arrow`](/commands/docs/polars_to-arrow.md) | Builtin,Plugin | Saves dataframe to arrow file. | -| [`polars to-avro`](/commands/docs/polars_to-avro.md) | Builtin,Plugin | Saves dataframe to avro file. | -| [`polars to-csv`](/commands/docs/polars_to-csv.md) | Builtin,Plugin | Saves dataframe to CSV file. | -| [`polars to-jsonl`](/commands/docs/polars_to-jsonl.md) | Builtin,Plugin | Saves dataframe to a JSON lines file. | -| [`polars to-parquet`](/commands/docs/polars_to-parquet.md) | Builtin,Plugin | Saves dataframe to parquet file. | -| [`polars unique`](/commands/docs/polars_unique.md) | Builtin,Plugin | Returns unique values from a dataframe. | -| [`polars uppercase`](/commands/docs/polars_uppercase.md) | Builtin,Plugin | Uppercase the strings in the column. | -| [`polars value-counts`](/commands/docs/polars_value-counts.md) | Builtin,Plugin | Returns a dataframe with the counts for unique values in series. | -| [`polars var`](/commands/docs/polars_var.md) | Builtin,Plugin | Create a var expression for an aggregation. | -| [`polars when`](/commands/docs/polars_when.md) | Builtin,Plugin | Creates and modifies a when expression. | -| [`polars with-column`](/commands/docs/polars_with-column.md) | Builtin,Plugin | Adds a series to the dataframe. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------ | +| [`polars agg`](/commands/docs/polars_agg.md) | Performs a series of aggregations from a group-by. | plugin | +| [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Creates an agg_groups expression. | plugin | +| [`polars all-false`](/commands/docs/polars_all-false.md) | Returns true if all values are false. | plugin | +| [`polars all-true`](/commands/docs/polars_all-true.md) | Returns true if all values are true. | plugin | +| [`polars append`](/commands/docs/polars_append.md) | Appends a new dataframe. | plugin | +| [`polars arg-max`](/commands/docs/polars_arg-max.md) | Return index for max value in series. | plugin | +| [`polars arg-min`](/commands/docs/polars_arg-min.md) | Return index for min value in series. | plugin | +| [`polars arg-sort`](/commands/docs/polars_arg-sort.md) | Returns indexes for a sorted series. | plugin | +| [`polars arg-true`](/commands/docs/polars_arg-true.md) | Returns indexes where values are true. | plugin | +| [`polars arg-unique`](/commands/docs/polars_arg-unique.md) | Returns indexes for unique values. | plugin | +| [`polars arg-where`](/commands/docs/polars_arg-where.md) | Creates an expression that returns the arguments where expression is true. | plugin | +| [`polars as`](/commands/docs/polars_as.md) | Creates an alias expression. | plugin | +| [`polars as-date`](/commands/docs/polars_as-date.md) | Converts string to date. | plugin | +| [`polars as-datetime`](/commands/docs/polars_as-datetime.md) | Converts string to datetime. | plugin | +| [`polars cache`](/commands/docs/polars_cache.md) | Caches operations in a new LazyFrame. | plugin | +| [`polars cast`](/commands/docs/polars_cast.md) | Cast a column to a different dtype. | plugin | +| [`polars col`](/commands/docs/polars_col.md) | Creates a named column expression. | plugin | +| [`polars collect`](/commands/docs/polars_collect.md) | Collect lazy dataframe into eager dataframe. | plugin | +| [`polars columns`](/commands/docs/polars_columns.md) | Show dataframe columns. | plugin | +| [`polars concat-str`](/commands/docs/polars_concat-str.md) | Creates a concat string expression. | plugin | +| [`polars concatenate`](/commands/docs/polars_concatenate.md) | Concatenates strings with other array. | plugin | +| [`polars contains`](/commands/docs/polars_contains.md) | Checks if a pattern is contained in a string. | plugin | +| [`polars count`](/commands/docs/polars_count.md) | Creates a count expression. | plugin | +| [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | +| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a series. | plugin | +| [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | +| [`polars drop`](/commands/docs/polars_drop.md) | Creates a new dataframe by dropping the selected columns. | plugin | +| [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Drops duplicate values in dataframe. | plugin | +| [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Drops null values in dataframe. | plugin | +| [`polars dummies`](/commands/docs/polars_dummies.md) | Creates a new dataframe with dummy variables. | plugin | +| [`polars explode`](/commands/docs/polars_explode.md) | Explodes a dataframe or creates a explode expression. | plugin | +| [`polars expr-not`](/commands/docs/polars_expr-not.md) | Creates a not expression. | plugin | +| [`polars fetch`](/commands/docs/polars_fetch.md) | Collects the lazyframe to the selected rows. | plugin | +| [`polars fill-nan`](/commands/docs/polars_fill-nan.md) | Replaces NaN values with the given expression. | plugin | +| [`polars fill-null`](/commands/docs/polars_fill-null.md) | Replaces NULL values with the given expression. | plugin | +| [`polars filter`](/commands/docs/polars_filter.md) | Filter dataframe based in expression. | plugin | +| [`polars filter-with`](/commands/docs/polars_filter-with.md) | Filters dataframe using a mask or expression as reference. | plugin | +| [`polars first`](/commands/docs/polars_first.md) | Show only the first number of rows or create a first expression | plugin | +| [`polars flatten`](/commands/docs/polars_flatten.md) | An alias for polars explode. | plugin | +| [`polars get`](/commands/docs/polars_get.md) | Creates dataframe with the selected columns. | plugin | +| [`polars get-day`](/commands/docs/polars_get-day.md) | Gets day from date. | plugin | +| [`polars get-hour`](/commands/docs/polars_get-hour.md) | Gets hour from date. | plugin | +| [`polars get-minute`](/commands/docs/polars_get-minute.md) | Gets minute from date. | plugin | +| [`polars get-month`](/commands/docs/polars_get-month.md) | Gets month from date. | plugin | +| [`polars get-nanosecond`](/commands/docs/polars_get-nanosecond.md) | Gets nanosecond from date. | plugin | +| [`polars get-ordinal`](/commands/docs/polars_get-ordinal.md) | Gets ordinal from date. | plugin | +| [`polars get-second`](/commands/docs/polars_get-second.md) | Gets second from date. | plugin | +| [`polars get-week`](/commands/docs/polars_get-week.md) | Gets week from date. | plugin | +| [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Gets weekday from date. | plugin | +| [`polars get-year`](/commands/docs/polars_get-year.md) | Gets year from date. | plugin | +| [`polars group-by`](/commands/docs/polars_group-by.md) | Creates a group-by object that can be used for other aggregations. | plugin | +| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates a group to a Series. | plugin | +| [`polars into-df`](/commands/docs/polars_into-df.md) | Converts a list, table or record into a dataframe. | plugin | +| [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Converts a dataframe into a lazy dataframe. | plugin | +| [`polars into-nu`](/commands/docs/polars_into-nu.md) | Converts a dataframe or an expression into into nushell value for access and exploration. | plugin | +| [`polars is-duplicated`](/commands/docs/polars_is-duplicated.md) | Creates mask indicating duplicated values. | plugin | +| [`polars is-in`](/commands/docs/polars_is-in.md) | Creates an is-in expression or checks to see if the elements are contained in the right series | plugin | +| [`polars is-not-null`](/commands/docs/polars_is-not-null.md) | Creates mask where value is not null. | plugin | +| [`polars is-null`](/commands/docs/polars_is-null.md) | Creates mask where value is null. | plugin | +| [`polars is-unique`](/commands/docs/polars_is-unique.md) | Creates mask indicating unique values. | plugin | +| [`polars join`](/commands/docs/polars_join.md) | Joins a lazy frame with other lazy frame. | plugin | +| [`polars last`](/commands/docs/polars_last.md) | Creates new dataframe with tail rows or creates a last expression. | plugin | +| [`polars lit`](/commands/docs/polars_lit.md) | Creates a literal expression. | plugin | +| [`polars lowercase`](/commands/docs/polars_lowercase.md) | Lowercase the strings in the column. | plugin | +| [`polars max`](/commands/docs/polars_max.md) | Creates a max expression or aggregates columns to their max value. | plugin | +| [`polars mean`](/commands/docs/polars_mean.md) | Creates a mean expression for an aggregation or aggregates columns to their mean value. | plugin | +| [`polars median`](/commands/docs/polars_median.md) | Median value from columns in a dataframe or creates expression for an aggregation | plugin | +| [`polars melt`](/commands/docs/polars_melt.md) | Unpivot a DataFrame from wide to long format. | plugin | +| [`polars min`](/commands/docs/polars_min.md) | Creates a min expression or aggregates columns to their min value. | plugin | +| [`polars n-unique`](/commands/docs/polars_n-unique.md) | Counts unique values. | plugin | +| [`polars not`](/commands/docs/polars_not.md) | Inverts boolean mask. | plugin | +| [`polars open`](/commands/docs/polars_open.md) | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. | plugin | +| [`polars otherwise`](/commands/docs/polars_otherwise.md) | Completes a when expression. | plugin | +| [`polars quantile`](/commands/docs/polars_quantile.md) | Aggregates the columns to the selected quantile. | plugin | +| [`polars query`](/commands/docs/polars_query.md) | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. | plugin | +| [`polars rename`](/commands/docs/polars_rename.md) | Rename a dataframe column. | plugin | +| [`polars replace`](/commands/docs/polars_replace.md) | Replace the leftmost (sub)string by a regex pattern. | plugin | +| [`polars replace-all`](/commands/docs/polars_replace-all.md) | Replace all (sub)strings by a regex pattern. | plugin | +| [`polars reverse`](/commands/docs/polars_reverse.md) | Reverses the LazyFrame | plugin | +| [`polars rolling`](/commands/docs/polars_rolling.md) | Rolling calculation for a series. | plugin | +| [`polars sample`](/commands/docs/polars_sample.md) | Create sample dataframe. | plugin | +| [`polars schema`](/commands/docs/polars_schema.md) | Show schema for a dataframe. | plugin | +| [`polars select`](/commands/docs/polars_select.md) | Selects columns from lazyframe. | plugin | +| [`polars set`](/commands/docs/polars_set.md) | Sets value where given mask is true. | plugin | +| [`polars set-with-idx`](/commands/docs/polars_set-with-idx.md) | Sets value in the given index. | plugin | +| [`polars shape`](/commands/docs/polars_shape.md) | Shows column and row size for a dataframe. | plugin | +| [`polars shift`](/commands/docs/polars_shift.md) | Shifts the values by a given period. | plugin | +| [`polars slice`](/commands/docs/polars_slice.md) | Creates new dataframe from a slice of rows. | plugin | +| [`polars sort-by`](/commands/docs/polars_sort-by.md) | Sorts a lazy dataframe based on expression(s). | plugin | +| [`polars std`](/commands/docs/polars_std.md) | Creates a std expression for an aggregation of std value from columns in a dataframe. | plugin | +| [`polars store-get`](/commands/docs/polars_store-get.md) | Gets a Dataframe or other object from the plugin cache. | plugin | +| [`polars store-ls`](/commands/docs/polars_store-ls.md) | Lists stored dataframes. | plugin | +| [`polars store-rm`](/commands/docs/polars_store-rm.md) | Removes a stored Dataframe or other object from the plugin cache. | plugin | +| [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | plugin | +| [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | +| [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | +| [`polars sum`](/commands/docs/polars_sum.md) | Creates a sum expression for an aggregation or aggregates columns to their sum value. | plugin | +| [`polars summary`](/commands/docs/polars_summary.md) | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. | plugin | +| [`polars take`](/commands/docs/polars_take.md) | Creates new dataframe using the given indices. | plugin | +| [`polars to-arrow`](/commands/docs/polars_to-arrow.md) | Saves dataframe to arrow file. | plugin | +| [`polars to-avro`](/commands/docs/polars_to-avro.md) | Saves dataframe to avro file. | plugin | +| [`polars to-csv`](/commands/docs/polars_to-csv.md) | Saves dataframe to CSV file. | plugin | +| [`polars to-jsonl`](/commands/docs/polars_to-jsonl.md) | Saves dataframe to a JSON lines file. | plugin | +| [`polars to-parquet`](/commands/docs/polars_to-parquet.md) | Saves dataframe to parquet file. | plugin | +| [`polars unique`](/commands/docs/polars_unique.md) | Returns unique values from a dataframe. | plugin | +| [`polars uppercase`](/commands/docs/polars_uppercase.md) | Uppercase the strings in the column. | plugin | +| [`polars value-counts`](/commands/docs/polars_value-counts.md) | Returns a dataframe with the counts for unique values in series. | plugin | +| [`polars var`](/commands/docs/polars_var.md) | Create a var expression for an aggregation. | plugin | +| [`polars when`](/commands/docs/polars_when.md) | Creates and modifies a when expression. | plugin | +| [`polars with-column`](/commands/docs/polars_with-column.md) | Adds a series to the dataframe. | plugin | \ No newline at end of file diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index cfdc3554b0..9974fcccfd 100644 --- a/commands/docs/polars_agg-groups.md +++ b/commands/docs/polars_agg-groups.md @@ -2,7 +2,7 @@ title: polars agg-groups categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates an agg_groups expression. usage: | diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index f834dd406f..0148c50d68 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index 654a241d29..23053e8dca 100644 --- a/commands/docs/polars_all-false.md +++ b/commands/docs/polars_all-false.md @@ -2,7 +2,7 @@ title: polars all-false categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Returns true if all values are false. usage: | diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index 680e59d03d..3cf92bc7dd 100644 --- a/commands/docs/polars_all-true.md +++ b/commands/docs/polars_all-true.md @@ -2,7 +2,7 @@ title: polars all-true categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Returns true if all values are true. usage: | diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index d5f07c6135..f78f48d9da 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index ac798838f4..8d95e014da 100644 --- a/commands/docs/polars_arg-max.md +++ b/commands/docs/polars_arg-max.md @@ -2,7 +2,7 @@ title: polars arg-max categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Return index for max value in series. usage: | diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index 4bc079c7c4..3330273520 100644 --- a/commands/docs/polars_arg-min.md +++ b/commands/docs/polars_arg-min.md @@ -2,7 +2,7 @@ title: polars arg-min categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Return index for min value in series. usage: | diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index 6accca30b2..0155acd137 100644 --- a/commands/docs/polars_arg-sort.md +++ b/commands/docs/polars_arg-sort.md @@ -2,7 +2,7 @@ title: polars arg-sort categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Returns indexes for a sorted series. usage: | diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index 04543c82ad..d5a485c2f8 100644 --- a/commands/docs/polars_arg-true.md +++ b/commands/docs/polars_arg-true.md @@ -2,7 +2,7 @@ title: polars arg-true categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Returns indexes where values are true. usage: | diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index 43069763cd..1caa6caafa 100644 --- a/commands/docs/polars_arg-unique.md +++ b/commands/docs/polars_arg-unique.md @@ -2,7 +2,7 @@ title: polars arg-unique categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Returns indexes for unique values. usage: | diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index eefa631189..416c2d999a 100644 --- a/commands/docs/polars_arg-where.md +++ b/commands/docs/polars_arg-where.md @@ -2,7 +2,7 @@ title: polars arg-where categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index cc7e905c1d..d1b5394c2a 100644 --- a/commands/docs/polars_as-date.md +++ b/commands/docs/polars_as-date.md @@ -2,7 +2,7 @@ title: polars as-date categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index e5a6ca6b19..6aea305b64 100644 --- a/commands/docs/polars_as-datetime.md +++ b/commands/docs/polars_as-datetime.md @@ -2,7 +2,7 @@ title: polars as-datetime categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 34220134f7..ae9a04d6c4 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index f237ebf218..7dc0b3c828 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Caches operations in a new LazyFrame. usage: | diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 881a361c7d..194cc3da4f 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Cast a column to a different dtype. usage: | diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index af53c8f93f..721bc85a30 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 001d4d5dbe..7806abdc7f 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index 771937b5bb..1731b7d98e 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 68f6532b23..561b878085 100644 --- a/commands/docs/polars_concat-str.md +++ b/commands/docs/polars_concat-str.md @@ -2,7 +2,7 @@ title: polars concat-str categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/polars_concatenate.md b/commands/docs/polars_concatenate.md index ef19f2101b..0601456f57 100644 --- a/commands/docs/polars_concatenate.md +++ b/commands/docs/polars_concatenate.md @@ -2,7 +2,7 @@ title: polars concatenate categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Concatenates strings with other array. usage: | diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 8ae0e2a263..3cb75448aa 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Checks if a pattern is contained in a string. usage: | diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 27793f868e..9db0331c26 100644 --- a/commands/docs/polars_count-null.md +++ b/commands/docs/polars_count-null.md @@ -2,7 +2,7 @@ title: polars count-null categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 8e070eb8af..86f6c95582 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a count expression. usage: | diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index 9f40af592f..6aa2e11dac 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Cumulative calculation for a series. usage: | diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index de61b471df..3e3d97e105 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -53,10 +53,10 @@ Creates an expression to capture multiple date parts (polars col datetime | polars datepart minute | polars as datetime_minute ), (polars col datetime | polars datepart second | polars as datetime_second ), (polars col datetime | polars datepart nanosecond | polars as datetime_ns ) ] -╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮ -│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │ -├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤ -│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │ -╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯ +╭─────┬───────────────┬─────────────────┬──────────────────┬───────────────┬────────────────┬──────────────────┬──────╮ +│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ ... │ +├─────┼───────────────┼─────────────────┼──────────────────┼───────────────┼────────────────┼──────────────────┼──────┤ +│ 0 │ 2 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ ... │ +╰─────┴───────────────┴─────────────────┴──────────────────┴───────────────┴────────────────┴──────────────────┴──────╯ ``` diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index aa0a291afc..b2e0109972 100644 --- a/commands/docs/polars_drop-duplicates.md +++ b/commands/docs/polars_drop-duplicates.md @@ -2,7 +2,7 @@ title: polars drop-duplicates categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Drops duplicate values in dataframe. usage: | diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index c0b0c89703..654a35ba65 100644 --- a/commands/docs/polars_drop-nulls.md +++ b/commands/docs/polars_drop-nulls.md @@ -2,7 +2,7 @@ title: polars drop-nulls categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index 7bc90b86cc..0440cc674f 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index c86aa0730b..8398edb1d4 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 7f5e463913..418c5c53b0 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index dbc723c34c..e2ef6b2ddc 100644 --- a/commands/docs/polars_expr-not.md +++ b/commands/docs/polars_expr-not.md @@ -2,7 +2,7 @@ title: polars expr-not categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a not expression. usage: | diff --git a/commands/docs/polars_fetch.md b/commands/docs/polars_fetch.md index ba2610c5a4..e199196959 100644 --- a/commands/docs/polars_fetch.md +++ b/commands/docs/polars_fetch.md @@ -2,7 +2,7 @@ title: polars fetch categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Collects the lazyframe to the selected rows. usage: | diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index d1f63d0c9e..34ccfb95be 100644 --- a/commands/docs/polars_fill-nan.md +++ b/commands/docs/polars_fill-nan.md @@ -2,7 +2,7 @@ title: polars fill-nan categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Replaces NaN values with the given expression. usage: | diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index 832bce7c40..e62bdcd9d0 100644 --- a/commands/docs/polars_fill-null.md +++ b/commands/docs/polars_fill-null.md @@ -2,7 +2,7 @@ title: polars fill-null categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Replaces NULL values with the given expression. usage: | diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index ac4c5bbbd0..797c715a02 100644 --- a/commands/docs/polars_filter-with.md +++ b/commands/docs/polars_filter-with.md @@ -2,7 +2,7 @@ title: polars filter-with categories: | dataframe or lazyframe -version: 0.93.0 +version: 0.94.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index 8ba7f58af5..fb2bdf4c0f 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index b929411f39..766a656a05 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Show only the first number of rows or create a first expression usage: | diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index b0b4e1c025..7fe75529dc 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | An alias for polars explode. usage: | diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index 4d689b72d0..e5bc5d463f 100644 --- a/commands/docs/polars_get-day.md +++ b/commands/docs/polars_get-day.md @@ -2,7 +2,7 @@ title: polars get-day categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index 4248b64498..a9bdae05d9 100644 --- a/commands/docs/polars_get-hour.md +++ b/commands/docs/polars_get-hour.md @@ -2,7 +2,7 @@ title: polars get-hour categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets hour from date. usage: | diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 670acd6ea7..d8c84000a3 100644 --- a/commands/docs/polars_get-minute.md +++ b/commands/docs/polars_get-minute.md @@ -2,7 +2,7 @@ title: polars get-minute categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index d3631f0809..614166b4bc 100644 --- a/commands/docs/polars_get-month.md +++ b/commands/docs/polars_get-month.md @@ -2,7 +2,7 @@ title: polars get-month categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 214b9ec2e1..4b822e0abb 100644 --- a/commands/docs/polars_get-nanosecond.md +++ b/commands/docs/polars_get-nanosecond.md @@ -2,7 +2,7 @@ title: polars get-nanosecond categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index fa19455808..b606946900 100644 --- a/commands/docs/polars_get-ordinal.md +++ b/commands/docs/polars_get-ordinal.md @@ -2,7 +2,7 @@ title: polars get-ordinal categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index 02e4174e22..cab826ec10 100644 --- a/commands/docs/polars_get-second.md +++ b/commands/docs/polars_get-second.md @@ -2,7 +2,7 @@ title: polars get-second categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index 4505e2422f..333d4ad30b 100644 --- a/commands/docs/polars_get-week.md +++ b/commands/docs/polars_get-week.md @@ -2,7 +2,7 @@ title: polars get-week categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index 9c3e1d149e..f854f36cad 100644 --- a/commands/docs/polars_get-weekday.md +++ b/commands/docs/polars_get-weekday.md @@ -2,7 +2,7 @@ title: polars get-weekday categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index 6da2c55965..cc8ceaa0c5 100644 --- a/commands/docs/polars_get-year.md +++ b/commands/docs/polars_get-year.md @@ -2,7 +2,7 @@ title: polars get-year categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 019de77136..c19e815a77 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates dataframe with the selected columns. usage: | diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index 37c0ee2bfa..a97b7d8a22 100644 --- a/commands/docs/polars_group-by.md +++ b/commands/docs/polars_group-by.md @@ -2,7 +2,7 @@ title: polars group-by categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 15893f32b5..2c19209b14 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Aggregates a group to a Series. usage: | diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index c733a2a3d0..14c6dcd057 100644 --- a/commands/docs/polars_into-df.md +++ b/commands/docs/polars_into-df.md @@ -2,7 +2,7 @@ title: polars into-df categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 54f1d0efd7..ddbd247532 100644 --- a/commands/docs/polars_into-lazy.md +++ b/commands/docs/polars_into-lazy.md @@ -2,7 +2,7 @@ title: polars into-lazy categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index 91060b302b..71b0ccb688 100644 --- a/commands/docs/polars_into-nu.md +++ b/commands/docs/polars_into-nu.md @@ -2,7 +2,7 @@ title: polars into-nu categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Converts a dataframe or an expression into into nushell value for access and exploration. usage: | diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 29137a14aa..86244401b0 100644 --- a/commands/docs/polars_is-duplicated.md +++ b/commands/docs/polars_is-duplicated.md @@ -2,7 +2,7 @@ title: polars is-duplicated categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates mask indicating duplicated values. usage: | diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index 83ffb71d1c..0afbe64c5f 100644 --- a/commands/docs/polars_is-in.md +++ b/commands/docs/polars_is-in.md @@ -2,7 +2,7 @@ title: polars is-in categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index f106c79c9a..b0d5c64a75 100644 --- a/commands/docs/polars_is-not-null.md +++ b/commands/docs/polars_is-not-null.md @@ -2,7 +2,7 @@ title: polars is-not-null categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates mask where value is not null. usage: | diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index ee07d14ce5..6a423bdb17 100644 --- a/commands/docs/polars_is-null.md +++ b/commands/docs/polars_is-null.md @@ -2,7 +2,7 @@ title: polars is-null categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates mask where value is null. usage: | diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index 183c415338..ca31a6b989 100644 --- a/commands/docs/polars_is-unique.md +++ b/commands/docs/polars_is-unique.md @@ -2,7 +2,7 @@ title: polars is-unique categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index 3d23ea386d..d87657811f 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 51cb2c3625..16e3e74a2c 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 79cea7c5a4..f5f0b571e8 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index b1cd46d823..6b0d0d47c0 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index 3818f7251c..ea40bac917 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a max expression or aggregates columns to their max value. usage: | diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index 0bcba105ab..9e86008915 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index b0102396f7..90442dc753 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | diff --git a/commands/docs/polars_melt.md b/commands/docs/polars_melt.md index e3d24dc32d..b10d78a840 100644 --- a/commands/docs/polars_melt.md +++ b/commands/docs/polars_melt.md @@ -2,7 +2,7 @@ title: polars melt categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index 8577e4b69e..b2ec1b89a0 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a min expression or aggregates columns to their min value. usage: | diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index fc26efc47f..0fc1d54ef6 100644 --- a/commands/docs/polars_n-unique.md +++ b/commands/docs/polars_n-unique.md @@ -2,7 +2,7 @@ title: polars n-unique categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 50a59f33a3..0f811cdd91 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 73cc5cc3ed..199a4931ff 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Opens CSV, JSON, JSON lines, arrow, avro, or parquet file to create dataframe. usage: | diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index 3596059311..112f8e0b8d 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Completes a when expression. usage: | diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index a10e133e45..7712235dad 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index 8dc60ca9a0..8450f2da90 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause. usage: | diff --git a/commands/docs/polars_rename.md b/commands/docs/polars_rename.md index cda763ce22..8345cf327d 100644 --- a/commands/docs/polars_rename.md +++ b/commands/docs/polars_rename.md @@ -2,7 +2,7 @@ title: polars rename categories: | dataframe or lazyframe -version: 0.93.0 +version: 0.94.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/polars_replace-all.md b/commands/docs/polars_replace-all.md index c085e99db4..3e66497840 100644 --- a/commands/docs/polars_replace-all.md +++ b/commands/docs/polars_replace-all.md @@ -2,7 +2,7 @@ title: polars replace-all categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index e1ba4e0b3a..c1a423005b 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index 0582feac98..6e84f28fb0 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index 98cbb3a38b..36e263ab41 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index 02da433a4a..0adab4d34b 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index 52f87b648b..494076ce66 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 2459cc0f13..caeb09236d 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index 10f8d62e76..8b3f0da02c 100644 --- a/commands/docs/polars_set-with-idx.md +++ b/commands/docs/polars_set-with-idx.md @@ -2,7 +2,7 @@ title: polars set-with-idx categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 51edabd48f..23494b78f4 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Sets value where given mask is true. usage: | diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index ff73b64404..166d4940ff 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Shows column and row size for a dataframe. usage: | diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index 8c8c3a4fff..0cd1499d74 100644 --- a/commands/docs/polars_shift.md +++ b/commands/docs/polars_shift.md @@ -2,7 +2,7 @@ title: polars shift categories: | dataframe or lazyframe -version: 0.93.0 +version: 0.94.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index d2a758507b..32b5b98f22 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates new dataframe from a slice of rows. usage: | diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index aa86180299..1004ea14cd 100644 --- a/commands/docs/polars_sort-by.md +++ b/commands/docs/polars_sort-by.md @@ -2,7 +2,7 @@ title: polars sort-by categories: | lazyframe -version: 0.93.0 +version: 0.94.0 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index 52ef7606c9..a2bc3638d4 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index 7ed3611b37..8f314e7b4e 100644 --- a/commands/docs/polars_store-get.md +++ b/commands/docs/polars_store-get.md @@ -2,7 +2,7 @@ title: polars store-get categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index 7a5ca2fbd6..1f633d5282 100644 --- a/commands/docs/polars_store-ls.md +++ b/commands/docs/polars_store-ls.md @@ -2,7 +2,7 @@ title: polars store-ls categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Lists stored dataframes. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 7d897e114a..b182a15122 100644 --- a/commands/docs/polars_store-rm.md +++ b/commands/docs/polars_store-rm.md @@ -2,7 +2,7 @@ title: polars store-rm categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Removes a stored Dataframe or other object from the plugin cache. usage: | diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index 94adbfc770..6eb34b6f78 100644 --- a/commands/docs/polars_str-lengths.md +++ b/commands/docs/polars_str-lengths.md @@ -2,7 +2,7 @@ title: polars str-lengths categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Get lengths of all strings. usage: | diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index d2f8470cee..c60ad810e7 100644 --- a/commands/docs/polars_str-slice.md +++ b/commands/docs/polars_str-slice.md @@ -2,7 +2,7 @@ title: polars str-slice categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Slices the string from the start position until the selected length. usage: | diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index abc0d5e76f..1412a0099f 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Formats date based on string rule. usage: | diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index a29a7bbe9a..2eb3ac929f 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 8dcb8642b1..83619c7e8a 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index eb2c5c75a4..01cb26b4d2 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/polars_to-arrow.md b/commands/docs/polars_to-arrow.md index a8bdb2ddd6..1ae68e68fa 100644 --- a/commands/docs/polars_to-arrow.md +++ b/commands/docs/polars_to-arrow.md @@ -2,7 +2,7 @@ title: polars to-arrow categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Saves dataframe to arrow file. usage: | diff --git a/commands/docs/polars_to-avro.md b/commands/docs/polars_to-avro.md index 128a81f40f..ba7d3a882b 100644 --- a/commands/docs/polars_to-avro.md +++ b/commands/docs/polars_to-avro.md @@ -2,7 +2,7 @@ title: polars to-avro categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Saves dataframe to avro file. usage: | diff --git a/commands/docs/polars_to-csv.md b/commands/docs/polars_to-csv.md index b1f0bb8570..b9d214b2f8 100644 --- a/commands/docs/polars_to-csv.md +++ b/commands/docs/polars_to-csv.md @@ -2,7 +2,7 @@ title: polars to-csv categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Saves dataframe to CSV file. usage: | diff --git a/commands/docs/polars_to-jsonl.md b/commands/docs/polars_to-jsonl.md index 3008e761fb..bd1e71709e 100644 --- a/commands/docs/polars_to-jsonl.md +++ b/commands/docs/polars_to-jsonl.md @@ -2,7 +2,7 @@ title: polars to-jsonl categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Saves dataframe to a JSON lines file. usage: | diff --git a/commands/docs/polars_to-parquet.md b/commands/docs/polars_to-parquet.md index 061d2e9552..77f47c148d 100644 --- a/commands/docs/polars_to-parquet.md +++ b/commands/docs/polars_to-parquet.md @@ -2,7 +2,7 @@ title: polars to-parquet categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Saves dataframe to parquet file. usage: | diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index 35c6d43f19..728d67a305 100644 --- a/commands/docs/polars_unique.md +++ b/commands/docs/polars_unique.md @@ -2,7 +2,7 @@ title: polars unique categories: | dataframe or lazyframe -version: 0.93.0 +version: 0.94.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index c3a5c3eb88..01bfb3c159 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Uppercase the strings in the column. usage: | diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index 47a2244aba..77fc9de2cb 100644 --- a/commands/docs/polars_value-counts.md +++ b/commands/docs/polars_value-counts.md @@ -2,7 +2,7 @@ title: polars value-counts categories: | dataframe -version: 0.93.0 +version: 0.94.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index 35a2c4dea0..04c9794745 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Create a var expression for an aggregation. usage: | diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index 006c56a367..2f1b17c917 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.93.0 +version: 0.94.0 expression: | Creates and modifies a when expression. usage: | diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index b2831efc4d..ca68a103be 100644 --- a/commands/docs/polars_with-column.md +++ b/commands/docs/polars_with-column.md @@ -2,7 +2,7 @@ title: polars with-column categories: | dataframe or lazyframe -version: 0.93.0 +version: 0.94.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index 680a8a19b8..ca70974038 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.93.0 +version: 0.94.0 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 67dcebf317..c6fefbbf7a 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 8ef558b06f..d25759a2a9 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 40fae0f86b..a1e3098c23 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.93.0 +version: 0.94.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index bb0ec4b24f..2fa3eec0a2 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.93.0 +version: 0.94.0 default: | Return the current working directory usage: | @@ -19,6 +19,10 @@ feature: default ```> pwd {flags} ``` +## Flags + + - `--physical, -P`: resolve symbolic links + ## Input/output types: diff --git a/commands/docs/query.md b/commands/docs/query.md index d7cbde638e..cb7e10edd5 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Show all the query commands usage: | @@ -29,9 +29,9 @@ feature: default ## Subcommands: -| name | type | usage | -| -------------------------------------------- | -------------- | --------------------------------------------------------------------------------- | -| [`query db`](/commands/docs/query_db.md) | Builtin | Query a database using SQL. | -| [`query json`](/commands/docs/query_json.md) | Builtin,Plugin | execute json query on json file (open --raw \ | query json 'query string') | -| [`query web`](/commands/docs/query_web.md) | Builtin,Plugin | execute selector query on html/web | -| [`query xml`](/commands/docs/query_xml.md) | Builtin,Plugin | execute xpath query on xml | \ No newline at end of file +| name | usage | type | +| -------------------------------------------- | --------------------------------------------------------------------------------- | -------- | +| [`query db`](/commands/docs/query_db.md) | Query a database using SQL. | built-in | +| [`query json`](/commands/docs/query_json.md) | execute json query on json file (open --raw \ | query json 'query string') | plugin | +| [`query web`](/commands/docs/query_web.md) | execute selector query on html/web | plugin | +| [`query xml`](/commands/docs/query_xml.md) | execute xpath query on xml | plugin | \ No newline at end of file diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 410d6cb629..f8eafc1bb3 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.93.0 +version: 0.94.0 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 45b1127499..b5b1c63494 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index 3087f92553..a6bc3e6404 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.93.0 +version: 0.94.0 network: | execute selector query on html/web usage: | diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index 1ed0393828..175e48d220 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | execute xpath query on xml usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index 1297e856cc..7204751d5d 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate a random value. usage: | @@ -31,11 +31,11 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | -------------------------------------------------- | -| [`random bool`](/commands/docs/random_bool.md) | Builtin | Generate a random boolean value. | -| [`random chars`](/commands/docs/random_chars.md) | Builtin | Generate random chars. | -| [`random dice`](/commands/docs/random_dice.md) | Builtin | Generate a random dice roll. | -| [`random float`](/commands/docs/random_float.md) | Builtin | Generate a random float within a range [min..max]. | -| [`random int`](/commands/docs/random_int.md) | Builtin | Generate a random integer [min..max]. | -| [`random uuid`](/commands/docs/random_uuid.md) | Builtin | Generate a random uuid4 string. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------ | -------------------------------------------------- | -------- | +| [`random bool`](/commands/docs/random_bool.md) | Generate a random boolean value. | built-in | +| [`random chars`](/commands/docs/random_chars.md) | Generate random chars. | built-in | +| [`random dice`](/commands/docs/random_dice.md) | Generate a random dice roll. | built-in | +| [`random float`](/commands/docs/random_float.md) | Generate a random float within a range [min..max]. | built-in | +| [`random int`](/commands/docs/random_int.md) | Generate a random integer [min..max]. | built-in | +| [`random uuid`](/commands/docs/random_uuid.md) | Generate a random uuid4 string. | built-in | \ No newline at end of file diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index f121c090c6..5332302b89 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index 201f3c9832..312fbf472e 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate random chars. usage: | diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index 05328fa10e..5e4a49778e 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index 5244bb771e..f9ffd22add 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate a random float within a range [min..max]. usage: | diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index 1bd5752797..f5458b6c16 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 00f25c6bdf..dba701d908 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.93.0 +version: 0.94.0 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index 725baff926..feda12c4d7 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 152bbb7b47..50fa51fa70 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Aggregate a list to a single value using an accumulator closure. usage: | diff --git a/commands/docs/register.md b/commands/docs/register.md index e99ebb3c4c..13ac88f8ba 100644 --- a/commands/docs/register.md +++ b/commands/docs/register.md @@ -2,7 +2,7 @@ title: register categories: | plugin -version: 0.93.0 +version: 0.94.0 plugin: | Register a plugin. usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index a97acd9d1a..fb9a88006b 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.93.0 +version: 0.94.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 415bc9bd9d..08b126a186 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Remove the given columns or rows from the table. Opposite of `select`. usage: | diff --git a/commands/docs/rename.md b/commands/docs/rename.md index 85303e8842..7758cc720d 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 3fd11ef60e..c9dee45546 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.93.0 +version: 0.94.0 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index f85610de67..73cf36e8c8 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index 4848554995..fb91b82585 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index d1b6a76c02..3fd19a4cd6 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Rolling commands for tables. usage: | @@ -31,9 +31,9 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| -------------------------------------------- | ------- | ---------------------------------- | -| [`roll down`](/commands/docs/roll_down.md) | Builtin | Roll table rows down. | -| [`roll left`](/commands/docs/roll_left.md) | Builtin | Roll record or table columns left. | -| [`roll right`](/commands/docs/roll_right.md) | Builtin | Roll table columns right. | -| [`roll up`](/commands/docs/roll_up.md) | Builtin | Roll table rows up. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------- | ---------------------------------- | -------- | +| [`roll down`](/commands/docs/roll_down.md) | Roll table rows down. | built-in | +| [`roll left`](/commands/docs/roll_left.md) | Roll record or table columns left. | built-in | +| [`roll right`](/commands/docs/roll_right.md) | Roll table columns right. | built-in | +| [`roll up`](/commands/docs/roll_up.md) | Roll table rows up. | built-in | \ No newline at end of file diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 95998cb284..0f4cecf5af 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 9e852a0b65..de045cbc42 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index d4656b8d16..c1da196a6c 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 7bc7778bba..34e41d2408 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 6ba50a6593..5b141c814a 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Rotates a table or record clockwise (default) or counter-clockwise (use --ccw flag). usage: | diff --git a/commands/docs/run-external.md b/commands/docs/run-external.md index d9abb16ccd..c6a11d9d30 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.93.0 +version: 0.94.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index 74bb5300c0..b579bb2845 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index af5d530f55..a262f01814 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.93.0 +version: 0.94.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 258843a411..592ffc2151 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.93.0 +version: 0.94.0 core: | Commands for getting info about what is in scope. usage: | @@ -29,11 +29,11 @@ feature: default ## Subcommands: -| name | type | usage | -| ------------------------------------------------------------ | ------- | -------------------------------------------------------- | -| [`scope aliases`](/commands/docs/scope_aliases.md) | Builtin | Output info on the aliases in the current scope. | -| [`scope commands`](/commands/docs/scope_commands.md) | Builtin | Output info on the commands in the current scope. | -| [`scope engine-stats`](/commands/docs/scope_engine-stats.md) | Builtin | Output stats on the engine in the current state. | -| [`scope externs`](/commands/docs/scope_externs.md) | Builtin | Output info on the known externals in the current scope. | -| [`scope modules`](/commands/docs/scope_modules.md) | Builtin | Output info on the modules in the current scope. | -| [`scope variables`](/commands/docs/scope_variables.md) | Builtin | Output info on the variables in the current scope. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------------------ | -------------------------------------------------------- | -------- | +| [`scope aliases`](/commands/docs/scope_aliases.md) | Output info on the aliases in the current scope. | built-in | +| [`scope commands`](/commands/docs/scope_commands.md) | Output info on the commands in the current scope. | built-in | +| [`scope engine-stats`](/commands/docs/scope_engine-stats.md) | Output stats on the engine in the current state. | built-in | +| [`scope externs`](/commands/docs/scope_externs.md) | Output info on the known externals in the current scope. | built-in | +| [`scope modules`](/commands/docs/scope_modules.md) | Output info on the modules in the current scope. | built-in | +| [`scope variables`](/commands/docs/scope_variables.md) | Output info on the variables in the current scope. | built-in | \ No newline at end of file diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index ec025a2bac..c04fa3df73 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.93.0 +version: 0.94.0 core: | Output info on the aliases in the current scope. usage: | diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index 2754103e63..ea7b9d665b 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.93.0 +version: 0.94.0 core: | Output info on the commands in the current scope. usage: | diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index 5ce590c369..11f2941cc1 100644 --- a/commands/docs/scope_engine-stats.md +++ b/commands/docs/scope_engine-stats.md @@ -2,7 +2,7 @@ title: scope engine-stats categories: | core -version: 0.93.0 +version: 0.94.0 core: | Output stats on the engine in the current state. usage: | diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index e0ae30bf02..8426a6813f 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.93.0 +version: 0.94.0 core: | Output info on the known externals in the current scope. usage: | diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index 21d7b2e56e..6906897978 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.93.0 +version: 0.94.0 core: | Output info on the modules in the current scope. usage: | diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index 19a6a41c67..c62ac9b095 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.93.0 +version: 0.94.0 core: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index 63ec2b7dfa..789b3bcafc 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | diff --git a/commands/docs/seq.md b/commands/docs/seq.md index eeab539f59..04397312b5 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.93.0 +version: 0.94.0 generators: | Output sequences of numbers. usage: | @@ -78,7 +78,7 @@ sequence 1 to 5, then convert to a string with a pipe separator ## Subcommands: -| name | type | usage | -| ---------------------------------------- | ------- | ------------------------------------- | -| [`seq char`](/commands/docs/seq_char.md) | Builtin | Print a sequence of ASCII characters. | -| [`seq date`](/commands/docs/seq_date.md) | Builtin | Print sequences of dates. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------- | ------------------------------------- | -------- | +| [`seq char`](/commands/docs/seq_char.md) | Print a sequence of ASCII characters. | built-in | +| [`seq date`](/commands/docs/seq_date.md) | Print sequences of dates. | built-in | \ No newline at end of file diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 98b4c9ba44..42b6f41236 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.93.0 +version: 0.94.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index f487a4bbd4..e78ab29b00 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.93.0 +version: 0.94.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shells.md b/commands/docs/shells.md index 181ea3fde4..d399f42097 100644 --- a/commands/docs/shells.md +++ b/commands/docs/shells.md @@ -2,7 +2,7 @@ title: shells categories: | shells -version: 0.92.0 +version: 0.94.0 shells: | Lists all open shells. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 1e86553d9a..c1d5f84e1e 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index ddc5a62a82..a8a1cb7297 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | @@ -28,6 +28,7 @@ feature: default | input | output | | --------- | --------- | +| binary | binary | | list\ | list\ | | table | table | ## Examples @@ -54,12 +55,20 @@ Skip two rows of a table ``` +Skip 2 bytes of a binary value +```nu +> 0x[01 23 45 67] | skip 2 +Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +00000000: 45 67 Eg + +``` + ## Notes To skip specific numbered rows, try `drop nth`. To skip specific named columns, try `reject`. ## Subcommands: -| name | type | usage | -| -------------------------------------------- | ------- | ----------------------------------------------------- | -| [`skip until`](/commands/docs/skip_until.md) | Builtin | Skip elements of the input until a predicate is true. | -| [`skip while`](/commands/docs/skip_while.md) | Builtin | Skip elements of the input while a predicate is true. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------- | ----------------------------------------------------- | -------- | +| [`skip until`](/commands/docs/skip_until.md) | Skip elements of the input until a predicate is true. | built-in | +| [`skip while`](/commands/docs/skip_while.md) | Skip elements of the input while a predicate is true. | built-in | \ No newline at end of file diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 02f59790bd..74de593e56 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Skip elements of the input until a predicate is true. usage: | diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index d553ec6db0..fbabb376c1 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Skip elements of the input while a predicate is true. usage: | diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index cfdb2b2e7c..269144410a 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index 13bb02150a..d60cbaaffb 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Sort by the given columns, in increasing order. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 6807ad4800..630377439b 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index bcdd6ec5d2..d3bd8ca7d6 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.93.0 +version: 0.94.0 core: | Source the environment from a source file into the current environment. usage: | diff --git a/commands/docs/source.md b/commands/docs/source.md index 0ee49a7d37..203b1f186a 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.93.0 +version: 0.94.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split-by.md b/commands/docs/split-by.md index ee3ae6e8e9..cf1f67328a 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Split a record into groups. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index dea722579e..15d6ae1a3f 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | @@ -31,10 +31,10 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | ------------------------------------------------------- | -| [`split chars`](/commands/docs/split_chars.md) | Builtin | Split a string into a list of characters. | -| [`split column`](/commands/docs/split_column.md) | Builtin | Split a string into multiple columns using a separator. | -| [`split list`](/commands/docs/split_list.md) | Builtin | Split a list into multiple lists using a separator. | -| [`split row`](/commands/docs/split_row.md) | Builtin | Split a string into multiple rows using a separator. | -| [`split words`](/commands/docs/split_words.md) | Builtin | Split a string's words into separate rows. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------ | ------------------------------------------------------- | -------- | +| [`split chars`](/commands/docs/split_chars.md) | Split a string into a list of characters. | built-in | +| [`split column`](/commands/docs/split_column.md) | Split a string into multiple columns using a separator. | built-in | +| [`split list`](/commands/docs/split_list.md) | Split a list into multiple lists using a separator. | built-in | +| [`split row`](/commands/docs/split_row.md) | Split a string into multiple rows using a separator. | built-in | +| [`split words`](/commands/docs/split_words.md) | Split a string's words into separate rows. | built-in | \ No newline at end of file diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index e608def48e..8a2e7dd17e 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Split a string into a list of characters. usage: | diff --git a/commands/docs/split_column.md b/commands/docs/split_column.md index 3472f1a430..4e2b6a98f1 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Split a string into multiple columns using a separator. usage: | diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index 6bcae305db..a2c9a7d6a0 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Split a list into multiple lists using a separator. usage: | diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index 2d254028ac..b5fd06a80b 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Split a string into multiple rows using a separator. usage: | diff --git a/commands/docs/split_words.md b/commands/docs/split_words.md index 4ebd9ba396..c4e3bc7f7c 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index b39607e738..fcfb4f8c3a 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Open a folder, file or website in the default application or viewer. usage: | diff --git a/commands/docs/stor.md b/commands/docs/stor.md index 53fa98c3d5..71eec4d055 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.93.0 +version: 0.94.0 database: | Various commands for working with the in-memory sqlite database. usage: | @@ -31,13 +31,13 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | --------------------------------------------------------------------------- | -| [`stor create`](/commands/docs/stor_create.md) | Builtin | Create a table in the in-memory sqlite database. | -| [`stor delete`](/commands/docs/stor_delete.md) | Builtin | Delete a table or specified rows in the in-memory sqlite database. | -| [`stor export`](/commands/docs/stor_export.md) | Builtin | Export the in-memory sqlite database to a sqlite database file. | -| [`stor import`](/commands/docs/stor_import.md) | Builtin | Import a sqlite database file into the in-memory sqlite database. | -| [`stor insert`](/commands/docs/stor_insert.md) | Builtin | Insert information into a specified table in the in-memory sqlite database. | -| [`stor open`](/commands/docs/stor_open.md) | Builtin | Opens the in-memory sqlite database. | -| [`stor reset`](/commands/docs/stor_reset.md) | Builtin | Reset the in-memory database by dropping all tables. | -| [`stor update`](/commands/docs/stor_update.md) | Builtin | Update information in a specified table in the in-memory sqlite database. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------- | --------------------------------------------------------------------------- | -------- | +| [`stor create`](/commands/docs/stor_create.md) | Create a table in the in-memory sqlite database. | built-in | +| [`stor delete`](/commands/docs/stor_delete.md) | Delete a table or specified rows in the in-memory sqlite database. | built-in | +| [`stor export`](/commands/docs/stor_export.md) | Export the in-memory sqlite database to a sqlite database file. | built-in | +| [`stor import`](/commands/docs/stor_import.md) | Import a sqlite database file into the in-memory sqlite database. | built-in | +| [`stor insert`](/commands/docs/stor_insert.md) | Insert information into a specified table in the in-memory sqlite database. | built-in | +| [`stor open`](/commands/docs/stor_open.md) | Opens the in-memory sqlite database. | built-in | +| [`stor reset`](/commands/docs/stor_reset.md) | Reset the in-memory database by dropping all tables. | built-in | +| [`stor update`](/commands/docs/stor_update.md) | Update information in a specified table in the in-memory sqlite database. | built-in | \ No newline at end of file diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index f7ef154f2d..022dbae06b 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.93.0 +version: 0.94.0 database: | Create a table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_delete.md b/commands/docs/stor_delete.md index cdc239498c..377f7b75e0 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.93.0 +version: 0.94.0 database: | Delete a table or specified rows in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_export.md b/commands/docs/stor_export.md index e0578125b9..fd6482e5d4 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.93.0 +version: 0.94.0 database: | Export the in-memory sqlite database to a sqlite database file. usage: | diff --git a/commands/docs/stor_import.md b/commands/docs/stor_import.md index 2c3e02d0a9..a17bca1f66 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.93.0 +version: 0.94.0 database: | Import a sqlite database file into the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index 12d2660ece..4938901a3a 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.93.0 +version: 0.94.0 database: | Insert information into a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index b21d77cbd3..8b6e543373 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.93.0 +version: 0.94.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index bf65aaf38b..f93d3b921d 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.93.0 +version: 0.94.0 database: | Reset the in-memory database by dropping all tables. usage: | diff --git a/commands/docs/stor_update.md b/commands/docs/stor_update.md index b5b448bd48..10b5cd034e 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.93.0 +version: 0.94.0 database: | Update information in a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/str.md b/commands/docs/str.md index a1b7c65d9a..08802edb22 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Various commands for working with string data. usage: | @@ -31,27 +31,27 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------------------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| [`str camel-case`](/commands/docs/str_camel-case.md) | Builtin | Convert a string to camelCase. | -| [`str capitalize`](/commands/docs/str_capitalize.md) | Builtin | Capitalize first letter of text. | -| [`str contains`](/commands/docs/str_contains.md) | Builtin | Checks if string input contains a substring. | -| [`str distance`](/commands/docs/str_distance.md) | Builtin | Compare two strings and return the edit distance/Levenshtein distance. | -| [`str downcase`](/commands/docs/str_downcase.md) | Builtin | Make text lowercase. | -| [`str ends-with`](/commands/docs/str_ends-with.md) | Builtin | Check if an input ends with a string. | -| [`str expand`](/commands/docs/str_expand.md) | Builtin | Generates all possible combinations defined in brace expansion syntax. | -| [`str index-of`](/commands/docs/str_index-of.md) | Builtin | Returns start index of first occurrence of string in input, or -1 if no match. | -| [`str join`](/commands/docs/str_join.md) | Builtin | Concatenate multiple strings into a single string, with an optional separator between each. | -| [`str kebab-case`](/commands/docs/str_kebab-case.md) | Builtin | Convert a string to kebab-case. | -| [`str length`](/commands/docs/str_length.md) | Builtin | Output the length of any strings in the pipeline. | -| [`str pascal-case`](/commands/docs/str_pascal-case.md) | Builtin | Convert a string to PascalCase. | -| [`str replace`](/commands/docs/str_replace.md) | Builtin | Find and replace text. | -| [`str reverse`](/commands/docs/str_reverse.md) | Builtin | Reverse every string in the pipeline. | -| [`str screaming-snake-case`](/commands/docs/str_screaming-snake-case.md) | Builtin | Convert a string to SCREAMING_SNAKE_CASE. | -| [`str snake-case`](/commands/docs/str_snake-case.md) | Builtin | Convert a string to snake_case. | -| [`str starts-with`](/commands/docs/str_starts-with.md) | Builtin | Check if an input starts with a string. | -| [`str stats`](/commands/docs/str_stats.md) | Builtin | Gather word count statistics on the text. | -| [`str substring`](/commands/docs/str_substring.md) | Builtin | Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. | -| [`str title-case`](/commands/docs/str_title-case.md) | Builtin | Convert a string to Title Case. | -| [`str trim`](/commands/docs/str_trim.md) | Builtin | Trim whitespace or specific character. | -| [`str upcase`](/commands/docs/str_upcase.md) | Builtin | Make text uppercase. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | -------- | +| [`str camel-case`](/commands/docs/str_camel-case.md) | Convert a string to camelCase. | built-in | +| [`str capitalize`](/commands/docs/str_capitalize.md) | Capitalize first letter of text. | built-in | +| [`str contains`](/commands/docs/str_contains.md) | Checks if string input contains a substring. | built-in | +| [`str distance`](/commands/docs/str_distance.md) | Compare two strings and return the edit distance/Levenshtein distance. | built-in | +| [`str downcase`](/commands/docs/str_downcase.md) | Make text lowercase. | built-in | +| [`str ends-with`](/commands/docs/str_ends-with.md) | Check if an input ends with a string. | built-in | +| [`str expand`](/commands/docs/str_expand.md) | Generates all possible combinations defined in brace expansion syntax. | built-in | +| [`str index-of`](/commands/docs/str_index-of.md) | Returns start index of first occurrence of string in input, or -1 if no match. | built-in | +| [`str join`](/commands/docs/str_join.md) | Concatenate multiple strings into a single string, with an optional separator between each. | built-in | +| [`str kebab-case`](/commands/docs/str_kebab-case.md) | Convert a string to kebab-case. | built-in | +| [`str length`](/commands/docs/str_length.md) | Output the length of any strings in the pipeline. | built-in | +| [`str pascal-case`](/commands/docs/str_pascal-case.md) | Convert a string to PascalCase. | built-in | +| [`str replace`](/commands/docs/str_replace.md) | Find and replace text. | built-in | +| [`str reverse`](/commands/docs/str_reverse.md) | Reverse every string in the pipeline. | built-in | +| [`str screaming-snake-case`](/commands/docs/str_screaming-snake-case.md) | Convert a string to SCREAMING_SNAKE_CASE. | built-in | +| [`str snake-case`](/commands/docs/str_snake-case.md) | Convert a string to snake_case. | built-in | +| [`str starts-with`](/commands/docs/str_starts-with.md) | Check if an input starts with a string. | built-in | +| [`str stats`](/commands/docs/str_stats.md) | Gather word count statistics on the text. | built-in | +| [`str substring`](/commands/docs/str_substring.md) | Get part of a string. Note that the first character of a string is index 0. | built-in | +| [`str title-case`](/commands/docs/str_title-case.md) | Convert a string to Title Case. | built-in | +| [`str trim`](/commands/docs/str_trim.md) | Trim whitespace or specific character. | built-in | +| [`str upcase`](/commands/docs/str_upcase.md) | Make text uppercase. | built-in | \ No newline at end of file diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index e51b056184..b613bcbbd4 100644 --- a/commands/docs/str_camel-case.md +++ b/commands/docs/str_camel-case.md @@ -2,7 +2,7 @@ title: str camel-case categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index d2e4c8cbcb..071d9fb0cb 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index 3f49b72000..3cf4f1c968 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Checks if string input contains a substring. usage: | @@ -22,7 +22,7 @@ feature: default ## Flags - `--ignore-case, -i`: search is case insensitive - - `--not, -n`: does not contain + - `--not, -n`: DEPRECATED OPTION: does not contain ## Parameters @@ -99,14 +99,3 @@ Check if list contains string ╰───┴───────╯ ``` - -Check if list does not contain string -```nu -> [one two three] | str contains --not o -╭───┬───────╮ -│ 0 │ false │ -│ 1 │ false │ -│ 2 │ true │ -╰───┴───────╯ - -``` diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index 781110656b..bae415bd13 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Compare two strings and return the edit distance/Levenshtein distance. usage: | diff --git a/commands/docs/str_downcase.md b/commands/docs/str_downcase.md index 61f640996b..36711e3e5d 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index 4bbedc8aa2..3664672207 100644 --- a/commands/docs/str_ends-with.md +++ b/commands/docs/str_ends-with.md @@ -2,7 +2,7 @@ title: str ends-with categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Check if an input ends with a string. usage: | diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 35da0d5c57..3601a4414e 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Generates all possible combinations defined in brace expansion syntax. usage: | diff --git a/commands/docs/str_index-of.md b/commands/docs/str_index-of.md index 789ecdd77f..4b8cd1f2a7 100644 --- a/commands/docs/str_index-of.md +++ b/commands/docs/str_index-of.md @@ -2,7 +2,7 @@ title: str index-of categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Returns start index of first occurrence of string in input, or -1 if no match. usage: | diff --git a/commands/docs/str_join.md b/commands/docs/str_join.md index 24e46b8140..149c021f1a 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Concatenate multiple strings into a single string, with an optional separator between each. usage: | diff --git a/commands/docs/str_kebab-case.md b/commands/docs/str_kebab-case.md index 512808147a..459158b3e8 100644 --- a/commands/docs/str_kebab-case.md +++ b/commands/docs/str_kebab-case.md @@ -2,7 +2,7 @@ title: str kebab-case categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index 4a7a1c610e..e3300c8996 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Output the length of any strings in the pipeline. usage: | diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index 9657b9452a..657ffa9291 100644 --- a/commands/docs/str_pascal-case.md +++ b/commands/docs/str_pascal-case.md @@ -2,7 +2,7 @@ title: str pascal-case categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index c6bdc78250..c592a6ef32 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index 4489932a0a..10cbb1c2cb 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Reverse every string in the pipeline. usage: | diff --git a/commands/docs/str_screaming-snake-case.md b/commands/docs/str_screaming-snake-case.md index a37b8a3bdd..d1a6a5d6bc 100644 --- a/commands/docs/str_screaming-snake-case.md +++ b/commands/docs/str_screaming-snake-case.md @@ -2,7 +2,7 @@ title: str screaming-snake-case categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Convert a string to SCREAMING_SNAKE_CASE. usage: | diff --git a/commands/docs/str_snake-case.md b/commands/docs/str_snake-case.md index ee59906f51..1acc7e9611 100644 --- a/commands/docs/str_snake-case.md +++ b/commands/docs/str_snake-case.md @@ -2,7 +2,7 @@ title: str snake-case categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Convert a string to snake_case. usage: | diff --git a/commands/docs/str_starts-with.md b/commands/docs/str_starts-with.md index 1ead4c389b..602fec37e7 100644 --- a/commands/docs/str_starts-with.md +++ b/commands/docs/str_starts-with.md @@ -2,7 +2,7 @@ title: str starts-with categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Check if an input starts with a string. usage: | diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md index 10581ffd3e..0d8db409b2 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 756d07ddec..9ff312f150 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,18 +2,18 @@ title: str substring categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | - Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. + Get part of a string. Note that the first character of a string is index 0. usage: | - Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. + Get part of a string. Note that the first character of a string is index 0. feature: default --- # `str substring` for [strings](/commands/categories/strings.md) -
Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0.
+
Get part of a string. Note that the first character of a string is index 0.
## Signature @@ -42,12 +42,12 @@ feature: default Get a substring "nushell" from the text "good nushell" using a range ```nu -> 'good nushell' | str substring 5..12 +> 'good nushell' | str substring 5..11 nushell ``` Count indexes and split using grapheme clusters ```nu -> '🇯🇵ほげ ふが ぴよ' | str substring --grapheme-clusters 4..6 +> '🇯🇵ほげ ふが ぴよ' | str substring --grapheme-clusters 4..5 ふが ``` diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index 58027daa53..f847ddcd8a 100644 --- a/commands/docs/str_title-case.md +++ b/commands/docs/str_title-case.md @@ -2,7 +2,7 @@ title: str title-case categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index a54925586d..3ff8159b4b 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index d01108af62..c8677fe606 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index a678ba7621..7c7df80eec 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.93.0 +version: 0.94.0 system: | View information about the system. usage: | @@ -34,14 +34,17 @@ Show info about the system ``` -Show the os system name with get -```nu -> (sys).host | get name +## Notes +Note that this command may take a noticeable amount of time to run. To reduce the time taken, you can use the various `sys` sub commands to get the subset of information you are interested in. -``` +## Subcommands: -Show the os system name -```nu -> (sys).host.name - -``` +| name | usage | type | +| ------------------------------------------ | ----------------------------------------------------- | -------- | +| [`sys cpu`](/commands/docs/sys_cpu.md) | View information about the system CPUs. | built-in | +| [`sys disks`](/commands/docs/sys_disks.md) | View information about the system disks. | built-in | +| [`sys host`](/commands/docs/sys_host.md) | View information about the system host. | built-in | +| [`sys mem`](/commands/docs/sys_mem.md) | View information about the system memory. | built-in | +| [`sys net`](/commands/docs/sys_net.md) | View information about the system network interfaces. | built-in | +| [`sys temp`](/commands/docs/sys_temp.md) | View the temperatures of system components. | built-in | +| [`sys users`](/commands/docs/sys_users.md) | View information about the users on the system. | built-in | \ No newline at end of file diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md new file mode 100644 index 0000000000..1b428d155e --- /dev/null +++ b/commands/docs/sys_cpu.md @@ -0,0 +1,35 @@ +--- +title: sys cpu +categories: | + system +version: 0.94.0 +system: | + View information about the system CPUs. +usage: | + View information about the system CPUs. +feature: default +--- + + +# `sys cpu` for [system](/commands/categories/system.md) + +
View information about the system CPUs.
+ +## Signature + +```> sys cpu {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | + +## Examples + +Show info about the system CPUs +```nu +> sys cpu + +``` diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md new file mode 100644 index 0000000000..77c964979a --- /dev/null +++ b/commands/docs/sys_disks.md @@ -0,0 +1,35 @@ +--- +title: sys disks +categories: | + system +version: 0.94.0 +system: | + View information about the system disks. +usage: | + View information about the system disks. +feature: default +--- + + +# `sys disks` for [system](/commands/categories/system.md) + +
View information about the system disks.
+ +## Signature + +```> sys disks {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | + +## Examples + +Show info about the system disks +```nu +> sys disks + +``` diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md new file mode 100644 index 0000000000..e5b119773c --- /dev/null +++ b/commands/docs/sys_host.md @@ -0,0 +1,35 @@ +--- +title: sys host +categories: | + system +version: 0.94.0 +system: | + View information about the system host. +usage: | + View information about the system host. +feature: default +--- + + +# `sys host` for [system](/commands/categories/system.md) + +
View information about the system host.
+ +## Signature + +```> sys host {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | + +## Examples + +Show info about the system host +```nu +> sys host + +``` diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md new file mode 100644 index 0000000000..14b17fe09e --- /dev/null +++ b/commands/docs/sys_mem.md @@ -0,0 +1,35 @@ +--- +title: sys mem +categories: | + system +version: 0.94.0 +system: | + View information about the system memory. +usage: | + View information about the system memory. +feature: default +--- + + +# `sys mem` for [system](/commands/categories/system.md) + +
View information about the system memory.
+ +## Signature + +```> sys mem {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | + +## Examples + +Show info about the system memory +```nu +> sys mem + +``` diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md new file mode 100644 index 0000000000..7e017b6884 --- /dev/null +++ b/commands/docs/sys_net.md @@ -0,0 +1,35 @@ +--- +title: sys net +categories: | + system +version: 0.94.0 +system: | + View information about the system network interfaces. +usage: | + View information about the system network interfaces. +feature: default +--- + + +# `sys net` for [system](/commands/categories/system.md) + +
View information about the system network interfaces.
+ +## Signature + +```> sys net {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | + +## Examples + +Show info about the system network +```nu +> sys net + +``` diff --git a/commands/docs/sys_temp.md b/commands/docs/sys_temp.md new file mode 100644 index 0000000000..a53e929330 --- /dev/null +++ b/commands/docs/sys_temp.md @@ -0,0 +1,38 @@ +--- +title: sys temp +categories: | + system +version: 0.94.0 +system: | + View the temperatures of system components. +usage: | + View the temperatures of system components. +feature: default +--- + + +# `sys temp` for [system](/commands/categories/system.md) + +
View the temperatures of system components.
+ +## Signature + +```> sys temp {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | table | + +## Examples + +Show the system temperatures +```nu +> sys temp + +``` + +## Notes +Some system components do not support temperature readings, so this command may return an empty list if no components support temperature. \ No newline at end of file diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md new file mode 100644 index 0000000000..7fe216635a --- /dev/null +++ b/commands/docs/sys_users.md @@ -0,0 +1,35 @@ +--- +title: sys users +categories: | + system +version: 0.94.0 +system: | + View information about the users on the system. +usage: | + View information about the users on the system. +feature: default +--- + + +# `sys users` for [system](/commands/categories/system.md) + +
View information about the users on the system.
+ +## Signature + +```> sys users {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | record | + +## Examples + +Show info about the system users +```nu +> sys users + +``` diff --git a/commands/docs/table.md b/commands/docs/table.md index 989fa4784c..2494290a14 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.93.0 +version: 0.94.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index 9d027bb50c..1a1258a02b 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | @@ -87,7 +87,7 @@ Return the first 3 elements of a range ## Subcommands: -| name | type | usage | -| -------------------------------------------- | ------- | ----------------------------------------------------- | -| [`take until`](/commands/docs/take_until.md) | Builtin | Take elements of the input until a predicate is true. | -| [`take while`](/commands/docs/take_while.md) | Builtin | Take elements of the input while a predicate is true. | \ No newline at end of file +| name | usage | type | +| -------------------------------------------- | ----------------------------------------------------- | -------- | +| [`take until`](/commands/docs/take_until.md) | Take elements of the input until a predicate is true. | built-in | +| [`take while`](/commands/docs/take_while.md) | Take elements of the input while a predicate is true. | built-in | \ No newline at end of file diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index eef44eed12..5655544df7 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Take elements of the input until a predicate is true. usage: | diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index 0fd512278c..64187ae4cb 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Take elements of the input while a predicate is true. usage: | diff --git a/commands/docs/tee.md b/commands/docs/tee.md index 4d28fd44cd..f0769f0d02 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index c7cbfba364..36e84df58b 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Returns a record containing the number of columns (width) and rows (height) of the terminal. usage: | diff --git a/commands/docs/timeit.md b/commands/docs/timeit.md index 78c805460a..9edec90eb3 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index b83c24c8cb..972f73f582 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Translate structured data to a format. usage: | @@ -31,17 +31,17 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | ------------------------------------------------------------- | -| [`to csv`](/commands/docs/to_csv.md) | Builtin | Convert table into .csv text . | -| [`to html`](/commands/docs/to_html.md) | Builtin | Convert table into simple HTML. | -| [`to json`](/commands/docs/to_json.md) | Builtin | Converts table data into JSON text. | -| [`to md`](/commands/docs/to_md.md) | Builtin | Convert table into simple Markdown. | -| [`to msgpack`](/commands/docs/to_msgpack.md) | Builtin | Convert Nu values into MessagePack. | -| [`to msgpackz`](/commands/docs/to_msgpackz.md) | Builtin | Convert Nu values into brotli-compressed MessagePack. | -| [`to nuon`](/commands/docs/to_nuon.md) | Builtin | Converts table data into Nuon (Nushell Object Notation) text. | -| [`to text`](/commands/docs/to_text.md) | Builtin | Converts data into simple text. | -| [`to toml`](/commands/docs/to_toml.md) | Builtin | Convert record into .toml text. | -| [`to tsv`](/commands/docs/to_tsv.md) | Builtin | Convert table into .tsv text. | -| [`to xml`](/commands/docs/to_xml.md) | Builtin | Convert special record structure into .xml text. | -| [`to yaml`](/commands/docs/to_yaml.md) | Builtin | Convert table into .yaml/.yml text. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------- | ------------------------------------------------------------- | -------- | +| [`to csv`](/commands/docs/to_csv.md) | Convert table into .csv text . | built-in | +| [`to html`](/commands/docs/to_html.md) | Convert table into simple HTML. | built-in | +| [`to json`](/commands/docs/to_json.md) | Converts table data into JSON text. | built-in | +| [`to md`](/commands/docs/to_md.md) | Convert table into simple Markdown. | built-in | +| [`to msgpack`](/commands/docs/to_msgpack.md) | Convert Nu values into MessagePack. | built-in | +| [`to msgpackz`](/commands/docs/to_msgpackz.md) | Convert Nu values into brotli-compressed MessagePack. | built-in | +| [`to nuon`](/commands/docs/to_nuon.md) | Converts table data into Nuon (Nushell Object Notation) text. | built-in | +| [`to text`](/commands/docs/to_text.md) | Converts data into simple text. | built-in | +| [`to toml`](/commands/docs/to_toml.md) | Convert record into .toml text. | built-in | +| [`to tsv`](/commands/docs/to_tsv.md) | Convert table into .tsv text. | built-in | +| [`to xml`](/commands/docs/to_xml.md) | Convert special record structure into .xml text. | built-in | +| [`to yaml`](/commands/docs/to_yaml.md) | Convert table into .yaml/.yml text. | built-in | \ No newline at end of file diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 9236fb1621..88f4b30054 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert table into .csv text . usage: | @@ -23,6 +23,7 @@ feature: default - `--separator, -s {string}`: a character to separate columns, defaults to ',' - `--noheaders, -n`: do not output the columns names as the first row + - `--columns, - {list}`: the names (in order) of the columns to use ## Input/output types: @@ -33,7 +34,7 @@ feature: default | table | string | ## Examples -Outputs an CSV string representing the contents of this table +Outputs a CSV string representing the contents of this table ```nu > [[foo bar]; [1 2]] | to csv foo,bar @@ -41,7 +42,7 @@ foo,bar ``` -Outputs an CSV string representing the contents of this table +Outputs a CSV string representing the contents of this table ```nu > [[foo bar]; [1 2]] | to csv --separator ';' foo;bar @@ -49,10 +50,18 @@ foo;bar ``` -Outputs an CSV string representing the contents of this record +Outputs a CSV string representing the contents of this record ```nu > {a: 1 b: 2} | to csv a,b 1,2 ``` + +Outputs a CSV stream with column names pre-determined +```nu +> [[foo bar baz]; [1 2 3]] | to csv --columns [baz foo] +baz,foo +3,1 + +``` diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index e3cdd8c29b..3a4fff17e1 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 63a18fc6d3..bd7ad5add1 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index f882d16b8b..8d1a98171e 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 89cb986779..36a080601a 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 021562536d..1bb5c79308 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 699dd46cfb..a952440d6c 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index eebf387f0c..e61b998ace 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index d6ed62f1ef..26bbe0d741 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 953b52aec4..4feec2737a 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert table into .tsv text. usage: | @@ -22,6 +22,7 @@ feature: default ## Flags - `--noheaders, -n`: do not output the column names as the first row + - `--columns, - {list}`: the names (in order) of the columns to use ## Input/output types: @@ -32,7 +33,7 @@ feature: default | table | string | ## Examples -Outputs an TSV string representing the contents of this table +Outputs a TSV string representing the contents of this table ```nu > [[foo bar]; [1 2]] | to tsv foobar @@ -40,10 +41,18 @@ foobar ``` -Outputs an TSV string representing the contents of this record +Outputs a TSV string representing the contents of this record ```nu > {a: 1 b: 2} | to tsv ab 12 ``` + +Outputs a TSV stream with column names pre-determined +```nu +> [[foo bar baz]; [1 2 3]] | to tsv --columns [baz foo] +bazfoo +31 + +``` diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 4a41c9e538..d368e41436 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert special record structure into .xml text. usage: | diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 056c0e02b2..59330e2ae3 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.93.0 +version: 0.94.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 7d175289de..507ab95399 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index c713609c3c..aeacd0b361 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | diff --git a/commands/docs/try.md b/commands/docs/try.md index 2d4f2df489..a0c2d1032c 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.93.0 +version: 0.94.0 core: | Try to run a block, if it fails optionally run a catch block. usage: | diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 8f5ce4c0e8..680e8d33ab 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.93.0 +version: 0.94.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index cdc22ab7be..bf89461479 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index d665024b18..8236d88620 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.93.0 +version: 0.94.0 system: | Print certain system information using uutils/coreutils uname. usage: | diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index c075451604..0e8f1ebd69 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Return the distinct values in the input by the given column(s). usage: | diff --git a/commands/docs/uniq.md b/commands/docs/uniq.md index 2f1a0a92e1..a27f5c9bcd 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index e5ed72a919..f861512fd5 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Update an existing column to have a new value. usage: | @@ -94,6 +94,6 @@ When updating a specific index, the closure will instead be run once. The first ## Subcommands: -| name | type | usage | -| ------------------------------------------------ | ------- | ----------------------- | -| [`update cells`](/commands/docs/update_cells.md) | Builtin | Update the table cells. | +| name | usage | type | +| ------------------------------------------------ | ----------------------- | -------- | +| [`update cells`](/commands/docs/update_cells.md) | Update the table cells. | built-in | diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index 4afa204183..ce46b4273c 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Update the table cells. usage: | @@ -48,11 +48,11 @@ Update the zero value cells to empty strings. $value } } -╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮ -│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ -├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ -│ 0 │ 37 │ │ │ │ 37 │ │ │ -╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯ +╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────╮ +│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ +├──────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┤ +│ 0 │ 37 │ │ │ │ 37 │ │ │ +╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────╯ ``` @@ -68,10 +68,10 @@ Update the zero value cells to empty strings in 2 last columns. $value } } -╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮ -│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ -├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ -│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │ -╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯ +╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────╮ +│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │ +├──────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┤ +│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │ +╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────╯ ``` diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 61517544d2..63465a2791 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Update an existing column to have a new value, or insert a new column. usage: | diff --git a/commands/docs/url.md b/commands/docs/url.md index 395daebe3f..31824bc7da 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.93.0 +version: 0.94.0 network: | Various commands for working with URLs. usage: | @@ -31,10 +31,10 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ------------------------------------------------------ | ------- | --------------------------------------------------------------------- | -| [`url build-query`](/commands/docs/url_build-query.md) | Builtin | Converts record or table into query string applying percent-encoding. | -| [`url decode`](/commands/docs/url_decode.md) | Builtin | Converts a percent-encoded web safe string to a string. | -| [`url encode`](/commands/docs/url_encode.md) | Builtin | Converts a string to a percent encoded web safe string. | -| [`url join`](/commands/docs/url_join.md) | Builtin | Converts a record to url. | -| [`url parse`](/commands/docs/url_parse.md) | Builtin | Parses a url. | \ No newline at end of file +| name | usage | type | +| ------------------------------------------------------ | --------------------------------------------------------------------- | -------- | +| [`url build-query`](/commands/docs/url_build-query.md) | Converts record or table into query string applying percent-encoding. | built-in | +| [`url decode`](/commands/docs/url_decode.md) | Converts a percent-encoded web safe string to a string. | built-in | +| [`url encode`](/commands/docs/url_encode.md) | Converts a string to a percent encoded web safe string. | built-in | +| [`url join`](/commands/docs/url_join.md) | Converts a record to url. | built-in | +| [`url parse`](/commands/docs/url_parse.md) | Parses a url. | built-in | \ No newline at end of file diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 83968a43d9..377d2e82ad 100644 --- a/commands/docs/url_build-query.md +++ b/commands/docs/url_build-query.md @@ -2,7 +2,7 @@ title: url build-query categories: | network -version: 0.93.0 +version: 0.94.0 network: | Converts record or table into query string applying percent-encoding. usage: | diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index 2b88cc14e1..26255bbdb0 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Converts a percent-encoded web safe string to a string. usage: | diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index 16dc631473..f471a29cea 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.93.0 +version: 0.94.0 strings: | Converts a string to a percent encoded web safe string. usage: | diff --git a/commands/docs/url_join.md b/commands/docs/url_join.md index 291f1001ed..4788c632f9 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.93.0 +version: 0.94.0 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index 75c988dd3f..5efb352222 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.93.0 +version: 0.94.0 network: | Parses a url. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index d61cbd311f..f27269b82c 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.93.0 +version: 0.94.0 core: | Use definitions from a module, making them available in your shell. usage: | diff --git a/commands/docs/values.md b/commands/docs/values.md index 5a91693c91..3c11a7a268 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Given a record or table, produce a list of its columns' values. usage: | diff --git a/commands/docs/version.md b/commands/docs/version.md index 5f50362a03..60c4e32a47 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.93.0 +version: 0.94.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 19a7e0397e..ff8609fad2 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | Various commands for viewing debug information. usage: | @@ -31,8 +31,8 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | type | usage | -| ---------------------------------------------- | ------- | ---------------------------------------------------------- | -| [`view files`](/commands/docs/view_files.md) | Builtin | View the files registered in nushell's EngineState memory. | -| [`view source`](/commands/docs/view_source.md) | Builtin | View a block, module, or a definition. | -| [`view span`](/commands/docs/view_span.md) | Builtin | View the contents of a span. | \ No newline at end of file +| name | usage | type | +| ---------------------------------------------- | ---------------------------------------------------------- | -------- | +| [`view files`](/commands/docs/view_files.md) | View the files registered in nushell's EngineState memory. | built-in | +| [`view source`](/commands/docs/view_source.md) | View a block, module, or a definition. | built-in | +| [`view span`](/commands/docs/view_span.md) | View the contents of a span. | built-in | \ No newline at end of file diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 26bab8c60e..6c6e5f1291 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | View the files registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index a1c4c0790f..f2483b103f 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index 8455ab85c9..17d9d64243 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.93.0 +version: 0.94.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index e75774a711..4df11892f4 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.93.0 +version: 0.94.0 filesystem: | Watch for file changes and execute Nu code when they happen. usage: | diff --git a/commands/docs/where.md b/commands/docs/where.md index 4f60eadd57..0b4f76dbdb 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index faec4fec58..7a55c7f3bc 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.93.0 +version: 0.94.0 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 9c6d24d931..9ad316148c 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.93.0 +version: 0.94.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index d8a6653068..6980884ef7 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.93.0 +version: 0.94.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index 7d3c09c6bb..186b9b51ff 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Creates a sliding window of `window_size` that slide by n rows/elements across input. usage: | diff --git a/commands/docs/with-env.md b/commands/docs/with-env.md index fc7cbe4c41..81889c8e25 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.93.0 +version: 0.94.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 916e6014a1..c5b5116298 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 3d58d290ec..7845319d6f 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.93.0 +version: 0.94.0 filters: | Combine a stream with the input. usage: | diff --git a/make_docs.nu b/make_docs.nu index 6fa7c8de80..4a29479d37 100644 --- a/make_docs.nu +++ b/make_docs.nu @@ -10,7 +10,7 @@ def command-names [] { let nu_dir = (which nu) | get path.0 | path dirname mut plugins = [] for plugin in $PLUGINS { - if (sys).host.name == 'Windows' { + if (sys host | get name) == 'Windows' { $plugins ++= $'($nu_dir | path join $plugin).exe' } else { $plugins ++= $'($nu_dir | path join $plugin)' @@ -242,14 +242,11 @@ $"($example.description) # Typically a root command that has sub commands should be one word command let one_word_cmd = ($command.name | split row ' ' | length) == 1 let sub_commands = if $one_word_cmd { scope commands | where name =~ $'^($command.name) ' } else { [] } - let type_mapping = {is_builtin: 'Builtin', is_plugin: 'Plugin', is_custom: 'Custom'} let sub_commands = if $one_word_cmd and ($sub_commands | length) > 0 { let commands = $sub_commands - | select name usage is_builtin is_plugin is_custom + | select name usage type | update name {|it| $"[`($it.name)`]\(/commands/docs/($it.name | safe-path).md\)" } | upsert usage {|it| $it.usage | str replace -a '<' '\<' | str replace -a '>' '\>' } - | upsert type {|it| $type_mapping | columns | each {|t| if ($it | get $t) { $type_mapping | get $t } } | str join ',' } - | select name type usage | to md --pretty ['', '## Subcommands:', '', $commands, ''] | str join (char newline) } else { '' }