Skip to content

Commit daed316

Browse files
authored
fix(clone): use html render friendly lt, gt tags (#36)
1 parent 980c9a1 commit daed316

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

docs/cli/clone.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,39 @@ The `clone` command helps you create a copy of your Xata database or clone an ex
88
## Subcommands
99

1010
### start
11+
1112
Snapshot performs a snapshot of the configured source Postgres database into the configured target.
1213

1314
```bash
1415
xata clone start [--source-url <url>] [--config <file>] [--log-level <level>] [--dump-file <file>] [--postgres-url <url>] [--profile] [--reset] [--tables <tables>] [--target <type>] [--target-url <url>] [--organization <id>] [--project <id>] [--branch <id>] [--filter-tables <tables>] [--validation-mode <mode>] [--role <role>] [-h|--help]
1516
```
17+
1618
- `--source-url`: The source URL of the database to clone
1719
- `--config`: .env or .yaml config file to use with pgstream if any
1820
- `--log-level`: Log level for the application. One of trace, debug, info, warn, error, fatal, panic
1921
- `--dump-file`: File where the pg_dump output will be written
2022
- `--postgres-url`: Source postgres database to perform the snapshot from
2123
- `--profile`: Whether to produce CPU and memory profile files, as well as exposing a /debug/pprof endpoint on localhost:6060
2224
- `--reset`: Whether to reset the target before snapshotting (only for postgres target)
23-
- `--tables`: List of tables to snapshot, in the format <schema>.<table>. If not specified, the schema `public` will be assumed. Wildcards are supported
25+
- `--tables`: List of tables to snapshot, in the format `<schema>.<table>`. If not specified, the schema `public` will be assumed. Wildcards are supported
2426
- `--target`: Target type. One of postgres, opensearch, elasticsearch, kafka
2527
- `--target-url`: Target URL
2628
- `--organization`: Organization ID (default: "")
2729
- `--project`: Project ID (default: "")
2830
- `--branch`: Branch ID (default: "")
29-
- `--filter-tables`: Tables to filter (default: *.*)
31+
- `--filter-tables`: Tables to filter (default: _._)
3032
- `--validation-mode`: Anonymization validation mode, strict implies that all tables and columns should be specified (strict|relaxed|prompt, default: prompt)
3133
- `--role`: Postgres role to use for the clone
3234
- `-h, --help`: Print help information and exit
3335

3436
### config
37+
3538
Automatically configure the transforms for the clone command.
3639

3740
```bash
3841
xata clone config [--source-url <url>] [--mode <mode>] [--validation-mode <mode>] [--organization <id>] [--project <id>] [--branch <id>] [-h|--help]
3942
```
43+
4044
- `--source-url`: The source URL of the database to clone
4145
- `--mode`: The assisting mode to help with the configuration generation (auto|prompt|web|ai, default: prompt)
4246
- `--validation-mode`: Anonymization validation mode, strict implies that all tables and columns should be specified (strict|relaxed|prompt, default: prompt)
@@ -48,4 +52,4 @@ xata clone config [--source-url <url>] [--mode <mode>] [--validation-mode <mode>
4852
## Global Flags
4953

5054
- `-h, --help` - Print help information and exit
51-
- `--json` - Output in JSON format
55+
- `--json` - Output in JSON format

0 commit comments

Comments
 (0)