Skip to content

Commit 221e7bf

Browse files
committed
autogen(docs): generate cli docs
1 parent c564cfe commit 221e7bf

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed

docs/kratos/cli/kratos-cleanup-sql.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
id: kratos-cleanup-sql
3+
title: kratos cleanup sql
4+
description: kratos cleanup sql Cleanup sql database from expired flows and sessions
5+
---
6+
7+
<!--
8+
This file is auto-generated.
9+
10+
To improve this file please make your change against the appropriate "./cmd/*.go" file.
11+
-->
12+
## kratos cleanup sql
13+
14+
Cleanup sql database from expired flows and sessions
15+
16+
### Synopsis
17+
18+
Run this command as frequently as you need.
19+
It is recommended to run this command close to the SQL instance (e.g. same subnet) instead of over the public internet.
20+
This decreases risk of failure and decreases time required.
21+
You can read in the database URL using the -e flag, for example:
22+
export DSN=...
23+
kratos cleanup sql -e
24+
### WARNING ###
25+
Before running this command on an existing database, create a back up!
26+
27+
28+
```
29+
kratos cleanup sql <database-url> [flags]
30+
```
31+
32+
### Options
33+
34+
```
35+
-b, --database.cleanup.batch_size int Set the number of records to be cleaned per run (default 100)
36+
--database.cleanup.sleep.tables duration How long to wait between each table cleanup (default 1m0s)
37+
-h, --help help for sql
38+
--keep-last duration Don't remove records younger than
39+
-e, --read-from-env If set, reads the database connection string from the environment variable DSN or config file key dsn. (default true)
40+
```
41+
42+
### Options inherited from parent commands
43+
44+
```
45+
-c, --config strings Path to one or more .json, .yaml, .yml, .toml config files. Values are loaded in the order provided, meaning that the last config file overwrites values from the previous config file.
46+
```
47+
48+
### SEE ALSO
49+
50+
* [kratos cleanup](kratos-cleanup) - Various cleanup helpers
51+

docs/kratos/cli/kratos-cleanup.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
id: kratos-cleanup
3+
title: kratos cleanup
4+
description: kratos cleanup Various cleanup helpers
5+
---
6+
7+
<!--
8+
This file is auto-generated.
9+
10+
To improve this file please make your change against the appropriate "./cmd/*.go" file.
11+
-->
12+
## kratos cleanup
13+
14+
Various cleanup helpers
15+
16+
### Options
17+
18+
```
19+
-c, --config strings Path to one or more .json, .yaml, .yml, .toml config files. Values are loaded in the order provided, meaning that the last config file overwrites values from the previous config file.
20+
-h, --help help for cleanup
21+
```
22+
23+
### SEE ALSO
24+
25+
* [kratos](kratos) -
26+
* [kratos cleanup sql](kratos-cleanup-sql) - Cleanup sql database from expired flows and sessions
27+

docs/kratos/cli/kratos.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ To improve this file please make your change against the appropriate "./cmd/*.go
2121

2222
### SEE ALSO
2323

24+
* [kratos cleanup](kratos-cleanup) - Various cleanup helpers
2425
* [kratos courier](kratos-courier) - Commands related to the Ory Kratos message courier
2526
* [kratos delete](kratos-delete) - Delete resources
2627
* [kratos format](kratos-format) - Helpers for formatting code

0 commit comments

Comments
 (0)