Microsoft Dataverse

tap-dataverse (airbyte variant)🥉

Microsoft Dataverse is a data storage and management engine

The tap-dataverse extractor pulls data from Microsoft Dataverse that can then be sent to a destination using a loader.

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Alternate Implementations

Getting Started

Prerequisites

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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-dataverse extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-dataverse --variant airbyte
  2. Configure the tap-dataverse settings using 
    meltano config
     : 
    3. meltano config tap-dataverse set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-dataverse test

Next steps

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

Capabilities

The current capabilities for tap-dataverse 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
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

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

Settings

The tap-dataverse 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:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-dataverse 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.

Airbyte Config Client Id (airbyte_config.client_id)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_CONFIG_CLIENT_ID

App Registration Client Id


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_config client_id [value]

Airbyte Config Client Secret Value (airbyte_config.client_secret_value)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_CONFIG_CLIENT_SECRET_VALUE

App Registration Client Secret


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_config client_secret_value [value]

Airbyte Config Odata Maxpagesize (airbyte_config.odata_maxpagesize)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_CONFIG_ODATA_MAXPAGESIZE

Max number of results per page. Default=5000


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_config odata_maxpagesize [value]

Airbyte Config Tenant Id (airbyte_config.tenant_id)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_CONFIG_TENANT_ID

Tenant Id of your Microsoft Dataverse Instance


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_config tenant_id [value]

Airbyte Config Url (airbyte_config.url)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_CONFIG_URL

URL to Microsoft Dataverse API


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_config url [value]

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-microsoft-dataverse

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_DATAVERSE_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_DATAVERSE_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set docker_mounts [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_DATAVERSE_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_DATAVERSE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-dataverse set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_DATAVERSE_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-dataverse set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_DATAVERSE_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-dataverse 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-dataverse extractor to work, read the Airbyte connector FAQ, look for an existing issue in the Airbyte repository, file a new issue, or join the Meltano Slack community and ask for help in the 
#plugins-general
channel.

Install

meltano add extractor tap-dataverse --variant airbyte

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-microsoft-dataverse
  • Last Commit Date
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocolmeltano_sdk