Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add db tap metadata info #57

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add db tap metadata info #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion docs/DISCOVERY_MODE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ The breadcrumb object above defines the path into the schema to the node to whic

The `metadata` module in singer-python provides several utility functions for working with and writing metadata.

### Example
### Example
Here is an example of the catalog from the previous section with metadata:
```json
{
Expand Down Expand Up @@ -274,3 +274,34 @@ for stream_name in list_of_all_streams:
}
catalog['streams'].append(catalog_entry)
```

#### Database Tap Metadata
Database taps require some additional metadata.

#### Written during discovery:
- Stream Level
- `database-name`
- `schema-name`
- `is-view`
- `table-key-properties`
- Prop level
- `sql-datatype`
- UI supports following types as replication-keys for incremental:
- DATE
- TIMESTAMP
- NUMBER
- `inclusion`
- `selected-by-default`
- True for all fields except for those whose inclusion is "unsupported"

#### Read during sync:
- Stream Level
- `schema-name`
- `is-view`
- `table-key-properties` or `view-key-properties`
- `replication-key`
- `replication-key-value`
- `selected`
- Prop Level
- `sql-datatype`
- `selected`