Skip to content

Commit

Permalink
Regenerated and added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
caiusb committed Jan 23, 2024
1 parent 1233361 commit 99fe12d
Show file tree
Hide file tree
Showing 36 changed files with 4,339 additions and 20 deletions.
14 changes: 7 additions & 7 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
lockVersion: 2.0.0
id: 7ebb3741-2ac6-4c7d-96db-cce06c3d2bb5
management:
docChecksum: 2789f397868dd60c695104a366325f6b
docChecksum: 75addedbe555f7fcf2674ec734755162
docVersion: 2.6.13
speakeasyVersion: internal
generationVersion: 2.230.3
releaseVersion: 0.2.0
configChecksum: 08e534281040ac627259dfda2e6cf28e
generationVersion: 2.237.3
releaseVersion: 0.0.2
configChecksum: efc51e2fcd324e5ebee2b33bd25a9d58
features:
terraform:
constsAndDefaults: 0.1.2
core: 3.8.1
core: 3.8.4
deprecations: 2.81.1
globalSecurity: 2.81.2
globalSecurity: 2.81.3
globalServerURLs: 2.82.1
groups: 2.81.2
inputOutputModels: 2.83.0
methodSecurity: 2.82.0
methodSecurity: 2.82.1
nameOverrides: 2.81.1
typeOverrides: 2.81.1
unions: 2.81.7
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ generation:
fixes:
nameResolutionDec2023: true
terraform:
version: 0.2.0
version: 0.0.2
author: etleap
imports:
option: openapi
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ terraform {
required_providers {
etleap = {
source = "etleap/etleap"
version = "0.2.0"
version = "0.0.2"
}
}
}
Expand Down
53 changes: 53 additions & 0 deletions docs/data-sources/dbt_schedule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "etleap_dbt_schedule Data Source - terraform-provider-etleap"
subcategory: ""
description: |-
DbtSchedule DataSource
---

# etleap_dbt_schedule (Data Source)

DbtSchedule DataSource

## Example Usage

```terraform
data "etleap_dbt_schedule" "my_dbtschedule" {
id = "cc65bc92-8154-4552-a30c-048b8c2b5ed5"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The id of the dbt schedule

### Read-Only

- `connection_id` (String) The [connection](https://docs.etleap.com/docs/api-v2/edbec13814bbc-connection) where the dbt build runs. The only supported connections are Redshift, Snowflake or Databricks Delta Lake destinations.
- `create_date` (String)
- `cron` (String) The cron expression that defines triggers for this schedule. The maximum supported cron schedule precision is 1 minute.
- `current_activity` (String) must be one of ["LOADING", "BUILDING"]
- `last_dbt_build_date` (String) The last time that a successful dbt build started.
- `last_dbt_run_time` (Number) The duration of the last successful dbt build.
- `name` (String) The name of the dbt schedule.
- `owner` (Attributes) (see [below for nested schema](#nestedatt--owner))
- `paused` (Boolean) `true` if the schedule is paused.
- `selector` (String) The selector this schedule runs.
- `skip_build_if_no_new_data` (Boolean) Whether the dbt build is skipped if no new data has been ingested for any of the pipelines in the table above.
- `target_schema` (String) The target schema for the dbt build. See [here](https://docs.getdbt.com/docs/build/custom-schemas) for details on how it's used.

<a id="nestedatt--owner"></a>
### Nested Schema for `owner`

Read-Only:

- `email_address` (String)
- `first_name` (String)
- `id` (String)
- `last_name` (String)


195 changes: 195 additions & 0 deletions docs/data-sources/model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "etleap_model Data Source - terraform-provider-etleap"
subcategory: ""
description: |-
Model DataSource
---

# etleap_model (Data Source)

Model DataSource

## Example Usage

```terraform
data "etleap_model" "my_model" {
id = "f0cf07c6-6222-4082-90d5-a28144bbc66b"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `create_date` (String) The date and time when then the model was created.
- `dependencies` (Attributes List) (see [below for nested schema](#nestedatt--dependencies))
- `id` (String) The ID of this resource.
- `last_update_duration` (Number) How long the latest update took to complete, in milliseconds, or the duration of the current update if one is in progress.
- `last_update_time` (String) The date and time of the latest successful update for this model.
- `name` (String)
- `owner` (Attributes) (see [below for nested schema](#nestedatt--owner))
- `paused` (Boolean)
- `query_and_triggers` (Attributes) (see [below for nested schema](#nestedatt--query_and_triggers))
- `shares` (List of String) An array of users' emails that the model is shared with. Once shared, a model cannot be unshared, and future calls to `PATCH` can only add to this list.
- `update_schedule` (Attributes) How often this model should update. Etleap will periodically update the model table in your warehouse according to this schedule. See [the Model Updates documentation](https://docs.etleap.com/docs/documentation/ZG9jOjI0MzU2NDY3-introduction-to-models#model-updates) for more information. (see [below for nested schema](#nestedatt--update_schedule))
- `warehouse` (Attributes) (see [below for nested schema](#nestedatt--warehouse))

<a id="nestedatt--dependencies"></a>
### Nested Schema for `dependencies`

Read-Only:

- `id` (String) The unique identifier of the pipeline or model.
- `name` (String) The name of the pipeline or model.
- `type` (String) must be one of ["PIPELINE", "MODEL"]


<a id="nestedatt--owner"></a>
### Nested Schema for `owner`

Read-Only:

- `email_address` (String)
- `first_name` (String)
- `id` (String)
- `last_name` (String)


<a id="nestedatt--query_and_triggers"></a>
### Nested Schema for `query_and_triggers`

Read-Only:

- `query` (String) The SQL query used to build this model. To specify dependencies on pipelines or other models, replace the schema and table name of the dependency with the id of the dependency enclosed in `{{` and `}}`. The dependency must load data into the same Etleap connection as the one given in `warehouse.connectionId` for this model.

**For Example**
Say there is a pipeline with the id `abcd1234` which loads data to the table "schema"."my_table". To create a model in Etleap that has a dependency on this pipeline, the following query:

```sql
SELECT col1, col2 FROM "schema"."my_table";
```

becomes:
```sql
SELECT col1, col2 FROM {{abcd1234}};
```

[See the Model documentation](https://docs.etleap.com/docs/documentation/ZG9jOjI0MzU2NDY3-introduction-to-models#model-dependencies) for more information on Model dependencies.
- `triggers` (List of String) A list of model dependency ids. An update will be automatically triggered in this model if any of the dependencies listed here get new data. Any ids given here must be present as dependencies in the `query`.


<a id="nestedatt--update_schedule"></a>
### Nested Schema for `update_schedule`

Read-Only:

- `daily` (Attributes) (see [below for nested schema](#nestedatt--update_schedule--daily))
- `hourly` (Attributes) (see [below for nested schema](#nestedatt--update_schedule--hourly))
- `monthly` (Attributes) (see [below for nested schema](#nestedatt--update_schedule--monthly))
- `never` (Attributes) (see [below for nested schema](#nestedatt--update_schedule--never))
- `weekly` (Attributes) (see [below for nested schema](#nestedatt--update_schedule--weekly))

<a id="nestedatt--update_schedule--daily"></a>
### Nested Schema for `update_schedule.daily`

Read-Only:

- `hour_of_day` (Number) Hour of day this schedule should trigger at (in UTC).
- `mode` (String) must be one of ["DAILY"]


<a id="nestedatt--update_schedule--hourly"></a>
### Nested Schema for `update_schedule.hourly`

Read-Only:

- `mode` (String) must be one of ["HOURLY"]


<a id="nestedatt--update_schedule--monthly"></a>
### Nested Schema for `update_schedule.monthly`

Read-Only:

- `day_of_month` (Number) Day of the month this schedule should trigger at (in UTC).
- `hour_of_day` (Number) Hour of day this schedule should trigger at (in UTC).
- `mode` (String) must be one of ["MONTHLY"]


<a id="nestedatt--update_schedule--never"></a>
### Nested Schema for `update_schedule.never`

Read-Only:

- `mode` (String) must be one of ["NEVER"]


<a id="nestedatt--update_schedule--weekly"></a>
### Nested Schema for `update_schedule.weekly`

Read-Only:

- `day_of_week` (Number) The day of the week this schedule should trigger at (in UTC).
- `hour_of_day` (Number) Hour of day this schedule should trigger at (in UTC).
- `mode` (String) must be one of ["WEEKLY"]



<a id="nestedatt--warehouse"></a>
### Nested Schema for `warehouse`

Read-Only:

- `redshift` (Attributes) (see [below for nested schema](#nestedatt--warehouse--redshift))
- `snowflake` (Attributes) (see [below for nested schema](#nestedatt--warehouse--snowflake))

<a id="nestedatt--warehouse--redshift"></a>
### Nested Schema for `warehouse.redshift`

Read-Only:

- `connection_id` (String)
- `distribution_style` (Attributes) (see [below for nested schema](#nestedatt--warehouse--redshift--distribution_style))
- `materialized_view` (Boolean)
- `pending_renamed_table` (String) Only set when a table rename was triggered but is not complete yet.
- `schema` (String)
- `sort_columns` (List of String) The sort columns to use.
- `table` (String)
- `type` (String) must be one of ["REDSHIFT"]
- `wait_for_update_preparation` (Boolean)

<a id="nestedatt--warehouse--redshift--distribution_style"></a>
### Nested Schema for `warehouse.redshift.distribution_style`

Read-Only:

- `distribution_style_key` (Attributes) (see [below for nested schema](#nestedatt--warehouse--redshift--distribution_style--distribution_style_key))
- `one` (String) must be one of ["ALL", "AUTO", "EVEN"]

<a id="nestedatt--warehouse--redshift--distribution_style--distribution_style_key"></a>
### Nested Schema for `warehouse.redshift.distribution_style.one`

Read-Only:

- `column` (String)
- `type` (String) must be one of ["KEY"]




<a id="nestedatt--warehouse--snowflake"></a>
### Nested Schema for `warehouse.snowflake`

Read-Only:

- `connection_id` (String)
- `materialized_view` (Boolean)
- `pending_renamed_table` (String) Only set when a table rename was triggered but is not complete yet.
- `schema` (String)
- `table` (String)
- `type` (String) must be one of ["SNOWFLAKE"]
- `wait_for_update_preparation` (Boolean)


Loading

0 comments on commit 99fe12d

Please sign in to comment.