Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.withorb.com/llms.txt

Use this file to discover all available pages before exploring further.

Orb supports managed, daily exports of resource types to your data destination of your choice. Typically, this is a data warehouse such as Redshift or Snowflake, but other types of data stores are also supported. Exporting data from Orb can be done directly within the Orb UI; you can configure data exports directly within the UI.
Start using Orb data to power your workflows and reports, or talk to us to upgrade for access.

​
Export mechanics

Orb’s data exports are managed by Orb. This managed solution exports data directly to your destination of choice.

​
Supported destinations

Orb supports the following data destinations: We’re actively working to support more destinations. If you don’t see your destination of choice listed, please reach out to your Orb representative.

​
How Orb syncs changes

For nearly all resource types, Orb provides an incremental sync, which significantly reduces the data that is synced on a regular basis. The first sync that is run on the data exporter is a full sync (and may transfer a large number of resources). Future syncs after this are incremental and will only capture the updates that occur. In Orb’s system, changes to the core resource types (e.g. creations, updates, or deletes) are tracked internally. These records are used to help understand what changed and when. Using these records, Orb’s system is able to power the logic that determines which resource types need to be exported in a given timeframe during an incremental sync. Orb’s internal process has two, dependent stages:
  1. Serializing / dumping resources in preparation for the transfer process
  2. The transfer process where these resources are queried then copied to the end data store

​
Export UI

Note that only account admins are able to access the data exports UI and interact with data export connections.
The UI for the Data Export product can be found under “Data exports” within the Settings page. data-exports-empty-state A new data export connection can be added by clicking the “Create connection” button and filling out information about your data destination. The information needed about your data destination will differ depending on which destination system you’re choosing. The UI within Orb will dynamically provide you with the relevant inputs needed to configure a data export. data-exports-destination-info After filling in the required information about your data destination, you will be able to choose which resource types you want to sync. data-exports-connect-resource-types After creating a new data export connection, you’ll be able to view it directly in the UI. data-exports-enable-disable The UI also provides the ability to enable, disable, or delete your data export destination depending on its current state. Use the three vertical dots to see these options. The current status of the destination is also listed within the table and will appear differently if it is disabled.