Skip to content

Commit f4caeed

Browse files
Devansh Thakurrubenhoenle
Devansh Thakur
authored and
rubenhoenle
committed
intake component on STACKIT cli
1 parent 9069021 commit f4caeed

17 files changed

+2548
-0
lines changed

‎docs/stackit_beta_intake.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,10 @@ stackit beta intake [flags]
3030
### SEE ALSO
3131

3232
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
33+
* [stackit beta intake create](./stackit_beta_intake_create.md) - Creates a new Intake
34+
* [stackit beta intake delete](./stackit_beta_intake_delete.md) - Deletes an Intake
35+
* [stackit beta intake describe](./stackit_beta_intake_describe.md) - Shows details of an Intake
36+
* [stackit beta intake list](./stackit_beta_intake_list.md) - Lists all Intakes
3337
* [stackit beta intake runner](./stackit_beta_intake_runner.md) - Provides functionality for Intake Runners
38+
* [stackit beta intake update](./stackit_beta_intake_update.md) - Updates an Intake
3439

‎docs/stackit_beta_intake_create.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## stackit beta intake create
2+
3+
Creates a new Intake
4+
5+
### Synopsis
6+
7+
Creates a new Intake.
8+
9+
```
10+
stackit beta intake create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create a new Intake with required parameters
17+
$ stackit beta intake create --display-name my-intake --runner-id xxx --catalog-uri "http://dremio.example.com" --catalog-warehouse "my-warehouse"
18+
19+
Create a new Intake with a description, labels, and Dremio authentication
20+
$ stackit beta intake create --display-name my-intake --runner-id xxx --description "Production intake" --labels "env=prod,team=billing" --catalog-uri "http://dremio.example.com" --catalog-warehouse "my-warehouse" --catalog-auth-type "dremio" --dremio-token-endpoint "https://auth.dremio.cloud/oauth/token" --dremio-pat "MY_TOKEN"
21+
22+
Create a new Intake with manual partitioning by a date field
23+
$ stackit beta intake create --display-name my-partitioned-intake --runner-id xxx --catalog-uri "http://dremio.example.com" --catalog-warehouse "my-warehouse" --catalog-partitioning "manual" --catalog-partition-by "day(__intake_ts)"
24+
```
25+
26+
### Options
27+
28+
```
29+
--catalog-auth-type string Authentication type for the catalog (e.g., 'none', 'dremio')
30+
--catalog-namespace string The namespace to which data shall be written (default: 'intake')
31+
--catalog-partition-by strings List of Iceberg partitioning expressions. Only used when --catalog-partitioning is 'manual'
32+
--catalog-partitioning string The target table's partitioning. One of 'none', 'intake-time', 'manual'
33+
--catalog-table-name string The table name to identify the table in Iceberg
34+
--catalog-uri string The URI to the Iceberg catalog endpoint
35+
--catalog-warehouse string The Iceberg warehouse to connect to
36+
--description string Description
37+
--display-name string Display name
38+
--dremio-pat string Dremio personal access token. Required if auth-type is 'dremio'
39+
--dremio-token-endpoint string Dremio OAuth 2.0 token endpoint URL. Required if auth-type is 'dremio'
40+
-h, --help Help for "stackit beta intake create"
41+
--labels stringToString Labels in key=value format, separated by commas. Example: --labels "key1=value1,key2=value2" (default [])
42+
--runner-id string The UUID of the Intake Runner to use
43+
```
44+
45+
### Options inherited from parent commands
46+
47+
```
48+
-y, --assume-yes If set, skips all confirmation prompts
49+
--async If set, runs the command asynchronously
50+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
51+
-p, --project-id string Project ID
52+
--region string Target region for region-specific requests
53+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
54+
```
55+
56+
### SEE ALSO
57+
58+
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
59+

‎docs/stackit_beta_intake_delete.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit beta intake delete
2+
3+
Deletes an Intake
4+
5+
### Synopsis
6+
7+
Deletes an Intake.
8+
9+
```
10+
stackit beta intake delete INTAKE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete an Intake with ID "xxx"
17+
$ stackit beta intake delete xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta intake delete"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
40+

‎docs/stackit_beta_intake_describe.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit beta intake describe
2+
3+
Shows details of an Intake
4+
5+
### Synopsis
6+
7+
Shows details of an Intake.
8+
9+
```
10+
stackit beta intake describe INTAKE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of an Intake with ID "xxx"
17+
$ stackit beta intake describe xxx
18+
19+
Get details of an Intake with ID "xxx" in JSON format
20+
$ stackit beta intake describe xxx --output-format json
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit beta intake describe"
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-y, --assume-yes If set, skips all confirmation prompts
33+
--async If set, runs the command asynchronously
34+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
35+
-p, --project-id string Project ID
36+
--region string Target region for region-specific requests
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
43+

‎docs/stackit_beta_intake_list.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit beta intake list
2+
3+
Lists all Intakes
4+
5+
### Synopsis
6+
7+
Lists all Intakes for the current project.
8+
9+
```
10+
stackit beta intake list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all Intakes
17+
$ stackit beta intake list
18+
19+
List all Intakes in JSON format
20+
$ stackit beta intake list --output-format json
21+
22+
List up to 5 Intakes
23+
$ stackit beta intake list --limit 5
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit beta intake list"
30+
--limit int Maximum number of entries to list
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-y, --assume-yes If set, skips all confirmation prompts
37+
--async If set, runs the command asynchronously
38+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
39+
-p, --project-id string Project ID
40+
--region string Target region for region-specific requests
41+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
47+

‎docs/stackit_beta_intake_update.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## stackit beta intake update
2+
3+
Updates an Intake
4+
5+
### Synopsis
6+
7+
Updates an Intake. Only the specified fields are updated.
8+
9+
```
10+
stackit beta intake update INTAKE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update the display name of an Intake with ID "xxx"
17+
$ stackit beta intake update xxx --runner-id yyy --display-name new-intake-name
18+
19+
Update the catalog details for an Intake with ID "xxx"
20+
$ stackit beta intake update xxx --runner-id yyy --catalog-uri "http://new.uri" --catalog-warehouse "new-warehouse"
21+
```
22+
23+
### Options
24+
25+
```
26+
--catalog-auth-type string Authentication type for the catalog (e.g., 'none', 'dremio')
27+
--catalog-namespace string The namespace to which data shall be written
28+
--catalog-table-name string The table name to identify the table in Iceberg
29+
--catalog-uri string The URI to the Iceberg catalog endpoint
30+
--catalog-warehouse string The Iceberg warehouse to connect to
31+
--description string Description
32+
--display-name string Display name
33+
--dremio-pat string Dremio personal access token
34+
--dremio-token-endpoint string Dremio OAuth 2.0 token endpoint URL
35+
-h, --help Help for "stackit beta intake update"
36+
--labels stringToString Labels in key=value format, separated by commas. Example: --labels "key1=value1,key2=value2". (default [])
37+
--runner-id string The UUID of the Intake Runner to use
38+
```
39+
40+
### Options inherited from parent commands
41+
42+
```
43+
-y, --assume-yes If set, skips all confirmation prompts
44+
--async If set, runs the command asynchronously
45+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
46+
-p, --project-id string Project ID
47+
--region string Target region for region-specific requests
48+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
49+
```
50+
51+
### SEE ALSO
52+
53+
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
54+

0 commit comments

Comments
 (0)