tap-notion - Meltano Hub

Notion

tap-notion (renesteeman variant)🥇

Notion tap that can collect all your Notion pages, with support for incremental syncs.

The tap-notion extractor pulls data from Notion that can then be sent to a destination using a loader.

Alternate Implementations

Airbyte
🥉
renesteeman (default)🥇

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-notion extractor to your project using
```
meltano add
```
:

meltano add tap-notion

Configure the tap-notion settings using

meltano config

:

meltano config tap-notion set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-notion test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-notion may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
activate-version
batch
catalog
discover
schema-flattening
state
stream-maps
structured-logging

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-notion settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

auth_token
notion_version
page_size
search_filter_object
search_query
start_date
user_agent

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-notion list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Auth Token (auth_token)

Environment variable: TAP_NOTION_AUTH_TOKEN

The Notion integration token (starts with 'secret_').

Configure this setting directly using the following Meltano command:

meltano config tap-notion set auth_token [value]

Notion API Version (notion_version)

Environment variable: TAP_NOTION_NOTION_VERSION

Override the Notion-Version header (default '2022-06-28').

Configure this setting directly using the following Meltano command:

meltano config tap-notion set notion_version [value]

Page Size (page_size)

Environment variable: TAP_NOTION_PAGE_SIZE

Items per page for list/search endpoints (max 100).

Configure this setting directly using the following Meltano command:

meltano config tap-notion set page_size [value]

Search Filter Object (search_filter_object)

Environment variable: TAP_NOTION_SEARCH_FILTER_OBJECT

Optional search filter object type: 'page' or 'database'.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set search_filter_object [value]

Search Query (search_query)

Environment variable: TAP_NOTION_SEARCH_QUERY

Optional search query string.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set search_query [value]

Start Date (start_date)

Environment variable: TAP_NOTION_START_DATE

Initial cutoff timestamp for incremental sync on the 'search' stream. Client-side filter using last_edited_time; subsequent runs use saved state.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set start_date [value]

User Agent (user_agent)

Environment variable: TAP_NOTION_USER_AGENT

A custom User-Agent header to send with each request. Default is '/'

Configure this setting directly using the following Meltano command:

meltano config tap-notion set user_agent [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_NOTION_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_NOTION_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_NOTION_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_NOTION_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set batch_config storage.root [value]

Faker Locale (faker_config.locale)

Environment variable: TAP_NOTION_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-notion set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_NOTION_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-notion set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_NOTION_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_NOTION_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_NOTION_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_NOTION_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-notion set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-notion extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add
              tap-notion

Maintenance Status

Repo

https://github.com/renesteeman/meltano-tap-notion

Maintainer

Keywords