Saltar al contenido

Instagram Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8936 of the connector.

Get Started

Instagram Version Support

The connector models entities in the Instagram Graph API as relational tables.

Establish a Connection

Connect to Instagram

Instagram supports OAuth authentication only.

Desktop Applications

An embedded OAuth application is provided that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your application.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your application.
  • CallbackURL (custom application only): Set this to the redirect URI defined when you registered your application.

When you connect, the connector opens Instagram's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. The connector obtains an access token from Instagram and uses it to request data.
  2. The OAuth values are saved in the location specified in OAuthSettingsLocation. These values persist across connections.

The connector refreshes the access token automatically when it expires.

Create a Custom OAuth App

When to Create a Custom OAuth App

embeds OAuth Application Credentials with branding that can be used when connecting via a desktop application . Web applications require a custom OAuth application. You may choose to use your own OAuth Application Credentials when you want to

  • control branding of the Authentication Dialog
  • control the redirect URI that the application redirects the user to after the user authenticates
  • customize the permissions that you are requesting from the user

Allow Access to Instagram Data

To allow users to connect through the connector, complete the tasks below:

  1. Connect a Facebook Page to an Instagram account.
  2. Create and register the connector as an app with Instagram.
  3. Submit your app for Facebook's review.

Connect a Facebook Page to an Instagram Account

To access Instagram data, users need a role on a page that is associated with an Instagram account. Any user with a role on the page has access.

To connect a page and an Instagram account, log into Facebook and from your Page's settings, click Instagram, and log into your Instagram account. If your account is not an Instagram Business Account, follow the prompts to set up a business profile.

Create and Register the App

Register an app to obtain the values for the OAuthClientId and OAuthClientSecret properties. The OAuth client credentials authenticate the connector to Facebook.

  1. Log into Facebook and navigate to https://developers.facebook.com/apps.
  2. Create a new app and click Settings > Basic. The OAuthClientId is the App ID displayed. The OAuthClientSecret is the App Secret.
  3. Click Add Platform and select Website. Enter a Site URL. This value is not used in authentication.

Add the Facebook Login Product

Follow these steps to configure the OAuth redirect URI.

  1. Go to your app settings and add the Facebook Login product from the "Products" section.

  2. In the product settings, define the OAuth redirect URI.

    If you are building a desktop application, set the redirect URI to https://localhost:33333/, or a similar https URL.

    If you are building a web application, set the redirect URI you want to be used as the callback URL that users return to with the token that verifies that they have granted your app access.

Add the Instagram API Product

Follow these steps to configure the Instagram API permissions your app requests:

  1. Go to your app settings and add the Instagram product from the "Products" section.

  2. Configure the permissions in the product settings. To access all the tables and views, include the following scopes:

    • instagram_basic
    • instagram_manage_comments
    • instagram_manage_insights

    See the Data Model section for detailed information about the scopes required for specific tables.

Submit the App for Review to Go Live

While you can still with an application without review, to go live and fully access Instagram content, you must submit your application for review and approval.

  1. Click Manage for your application and on the Permissions tab click Start a Submission.
  2. Select the use case that best describes your Instagram integration.
  3. Fill in the form and wait for your application to be approved.

Authenticate to Instagram

Desktop Applications

After setting the following connection properties, you are ready to connect:

  • OAuthClientId: Set this to the App ID for your OAuth app.

  • OAuthClientSecret: Set this to the App Secret for your OAuth app.

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

  • BusinessAccountId: If you have more than one Facebook page connected with an Instagram account, set the BusinessAccountId connection property to specify the ID of a business account you have associated with a Facebook page.

    You can get a business account ID by querying the Page view.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation. These values persist across connections.
Web Applications

Follow the steps below to use the connector to get the OAuth token values and connect from a web application. Get an Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • OAuthClientId: Set this to the App ID in your app settings.
  • OAuthClientSecret: Set this to the App Secret in your app settings.

Then follow these steps to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the OAuth redirect URI you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.

  2. Log in and authorize the application. You are redirected back to the callback URL.

    The callback URL contains the verifier code in a query string parameter. Extract the verifier code from the callback URL.

  3. Set the following parameters and call GetOAuthAccessToken: | | | |-------------|----------------------------------------------------| | | | | Name | Value | | AuthMode | WEB | | Verifier | Set this to the verifier code. | | CallbackURL | Set this to the callback URL in your app settings. |

Connect to Data

To make requests to Instagram, set the OAuthAccessToken property. The OAuthAccessToken has a limited lifetime. When the token expires, you need to call the preceding stored procedures to reauthenticate.

Connect to Multiple Pages

If you have more than one Facebook page connected with an Instagram business account, set BusinessAccountId in addition to OAuthAccessToken. The BusinessAccountId property specifies the ID of a business account you have associated with a Facebook page.

You can get a business account ID by querying the Page View.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Instagram connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Instagram and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Instagram connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Users WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

The Instagram connector models entities in the Instagram API as Tables, Views, and Stored Procedures. These are defined in schema files, which are simple, text-based configuration files.

Discovering the Schemas Programmatically

The available System Tables provide programmatic access to schema information as well as other connector metadata, such as the data source's querying capabilities.

Tables

The connector models the data in Instagram as a list of tables in a relational database that can be queried using standard SQL statements.

Instagram Connector Tables

Name Description
Comments Create, delete, and query Comments on a media object. Requires the instagram_basic and instagram_manage_comments scopes.
Replies Query and insert replies on a media object. Requires the instagram_basic and instagram_manage_comments scopes.

Comments

Create, delete, and query Comments on a media object. Requires the instagram_basic and instagram_manage_comments scopes.

Only the select, delete, and insert operations are supported.

Select

The connector will use the Instagram APIs to filter results by MediaId and will execute other filters client-side within itself.

  • The following query returns all comments on all media in your account. UserId will be null if the comment is from an account that is not a business account.

    SELECT * FROM Comments
    
  • To query comments for a specific media object, MediaId is required. The MediaId column supports the = operator. For example:

    SELECT * FROM Comments WHERE MediaId = '1501471279105199430_5380790872'
    
Insert

Create a comment on a media object with the following rules:

  • MediaId and Text are the only available and required fields.
  • The total length of the comment cannot exceed 300 characters.
  • The comment cannot contain more than 4 hashtags.
  • The comment cannot contain more than 1 URL.
  • The comment cannot consist of all capital letters.

For example:

INSERT INTO Comments (MediaId, Text) VALUES ('1501471279105199430_5380790872', 'My comment text #instadevelopers')
Update

UPDATE is not supported.

Delete

Id (the comment's primary key) is required. For example, the following query removes a comment either on the authenticated user's media object or authored by the authenticated user.

DELETE FROM Comments WHERE ID = '1668776136772254'
Columns
Name Type ReadOnly Description
Id [KEY] String True The unique identifier for the comment.
Text String False The text of the comment.
MediaId String False The unique identifier for the media.
Created Datetime True The time when the media was created.
UserId String True The unique identifier for the user.
Username String True The username for the user.
Likes Int True The number of likes.
Hidden Boolean True The boolean that shows if the comment is hidden.
InstagramBusinessAccountId String True The unique identifier for the Instagram business account Id.

Replies

Query and insert replies on a media object. Requires the instagram_basic and instagram_manage_comments scopes.

Only the select and insert operations are supported.

Select

The connector will process a filter on CommentId server side and will execute other filters client-side within itself.

  • The following query returns replies from all comments in your account. UserId will be null if the reply is from an account that is not a business account.

    SELECT * FROM Replies
    
  • To query replies for a specific comment, CommentId is required. The supported operator for the CommentId column is =. For example:

    SELECT * FROM Replies WHERE CommentId = '1501471279105199430_5380790872'
    
Insert

Create a reply on a comment object with the following rules:

  • CommentId and Text are the only available and required fields.
  • The total length of the comment cannot exceed 300 characters.
  • The reply cannot contain more than 4 hashtags.
  • The reply cannot contain more than 1 URL.
  • The reply cannot consist of all capital letters.

For example:

INSERT INTO Replies (CommentId, Text) VALUES ('1501471279105199430_5380790872', 'My reply #instadevelopers')
Update

UPDATE is not supported.

Delete

Delete is not supported.

Columns
Name Type ReadOnly Description
Id [KEY] String True The unique identifier for the reply.
Username String True The username for the user.
CommentId String False The unique identifier for the comment.
Created Datetime True The time when the reply was created.
UserId String True The unique identifier for the user.
MediaId String True The unique identifier for the associated media.
Text String False The comment.
LikeCount Int True The number of likes.
InstagramBusinessAccountId String True The unique identifier for the Instagram business account Id.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Instagram Connector Views

Name Description
AccountContactButtonType It returns the number of taps on the DIRECTION, CALLs and EMAILs button during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is contact_button_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountFollowersNonfollowers The number of accounts that followed and the number of accounts that unfollowed or stopped using Instagram during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountInsights Allows you to get insights for an Instagram business account. Requires the instagram_basic and instagram_manage_insights scopes.
AccountMediaProductType It returns the number of POSTs and IGTVs during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountTimeSeriesFollowType It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountTimeSeriesMediaProductType It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountTimeSeriesWithoutBreakdown It returns the metric endtime and the value. For this view, the Metric type is time_series. Requires the instagram_basic and instagram_manage_insights scopes.
AccountWithoutBreakdown It returns the total values of the metric type in Instagram. For eg, if the metric type is impressions, it will return the number of times your posts, stories, reels, videos and live videos were on screen, including in ads. For this view, the Metric Type is total_value. Requires the instagram_basic and instagram_manage_insights scopes.
AudienceInsights Retrieve follower insights for an Instagram business account.
IGMedia This View Represents an Instagram Photo, Video, Story, Album, or IGTV media.
InstagramBusinessProfile Get information about the Instagram Business account. Requires the instagram_basic scope, business_management, manage_pages .
InstagramPages Query information about pages connected to the Facebook account. Requires the instagram_basic scope.
Media Query media objects. Requires the instagram_basic and instagram_content_publish scopes.
MediaInsightReels Allows you to get insights for reel media object. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsights Allows you to get insights for an individual media object. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsightsPost Allows you to get insights for an individual media object for image and video POSTs. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsightsPostAlbum Allows you to get insights for an individual media object for carousel album POSTs. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsightsStory Allows you to get insights for an individual media object for Story. Requires the instagram_basic and instagram_manage_insights scopes.
OnlineFollowers Query Online Followers insights as hourly totals. Requires the instagram_basic and instagram_manage_insights scopes.
Pages Get details of Pages. Requires a custom OAuth app with 'pages_read_engagement' permission or the 'Page Public Content Access' feature or the 'Page Public Metadata Access' feature.
Permissions Query the Permissions the User has granted the current application.
Stories Query Stories. Requires the instagram_basic and instagram_manage_insights scopes.
Tags Query tags. Requires the instagram_basic and instagram_manage_comments scopes.

AccountContactButtonType

It returns the number of taps on the DIRECTION, CALLs and EMAILs button during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is contact_button_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the = operator.

The default query returns results for the 'profile_links_taps' metric.

SELECT * FROM AccountContactButtonType
SELECT * FROM AccountContactButtonType WHERE FromDateTime='2023-07-02T00:00:00Z' AND ToDateTime='2023-07-24T00:00:00Z'
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
Metric String Metric Type. Default value is profile_links_taps. The allowed values are profile_links_taps.
DIRECTION Int Number of taps on DIRECTION button.
CALL Int Number of taps on Calls button.
EMAIL Int Number of taps on Emails button.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountFollowersNonfollowers

The number of accounts that followed and the number of accounts that unfollowed or stopped using Instagram during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the =, and IN operators.

The default query returns results for the 'follows_and_unfollows' metric.

SELECT * FROM AccountFollowersNonfollowers
SELECT * FROM AccountFollowersNonfollowers WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'

To retrieve the result for other metrics, then explicitly specify the Metric in where clause. For example:

SELECT * FROM AccountFollowersNonfollowers WHERE Metric = 'reach'
SELECT * FROM AccountFollowersNonfollowers WHERE Metric IN ('follows_and_unfollows', 'reach')
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
Metric String Metric Type. Default value is follows_and_unfollows. The allowed values are follows_and_unfollows, reach.
Follower Int The number of accounts that followed the Instagram business account
Nonfollower Int The number of accounts that unfollowed the Instagram business account
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountInsights

Allows you to get insights for an Instagram business account. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics given a date range. The default date range is the last 7 days.

  • Impressions (accepts time periods of day, week, and days_28)
  • Reach (accepts time periods of day, week, and days_28)
  • FollowerCount (only accepts the day period)
  • EmailContacts (only accepts the day period)
  • PhoneCallClicks (only accepts the day period)
  • TextMessageClicks (only accepts the day period)
  • GetDirectionsClicks (only accepts the day period)
  • WebsiteClicks (only accepts the day period)
  • ProfileViews (only accepts the day period)

Specify a date range with the FromDateTime and ToDateTime columns. Specify the intervals of the date range by setting the Period column in the WHERE clause. Note that you cannot use a period on a metric that does not support it. For example, you cannot use Impressions AND FollowerCount with period days_28 because FollowerCount only supports the day period.

The connector will use the Instagram APIs to process filters that refer to a date range or Id. The connector processes other filters client-side within itself.

The following examples show how to retrieve metrics over a given date range:

  • The default query returns results for the following metrics during the last seven days: Impressions, Reach, FollowerCount, EmailContacts, PhoneCallClicks, TextMessageClicks, GetDirectionsClicks, WebsiteClicks, and ProfileViews.

    SELECT * FROM AccountInsights
    
  • Filter on FromDateTime and ToDateTime to explicitly specify a different date range. The max date range cannot be more than 30 days (2592000 s).

    SELECT * FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30' AND period = 'day'
    
  • Return results over a period of 7 days.

    SELECT * FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND period = 'day'
    
  • Return results from 2018/01/01 to 2018/01/08.

    SELECT * FROM AccountInsights WHERE ToDateTime = '2018/01/08' AND period = 'day'
    
  • Return a custom projection on account insights for the date range from 2018/01/01 to 2018/01/08.

    SELECT Impressions, FollowerCount, EmailContacts FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30' AND period = 'day'
    
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier of the Instagram business account Id.
EndTime Date The most recent date this insight data is relevant for.
Impressions Integer Total number of times this profile has been seen.
Reach Integer Total number of unique accounts that have seen this profile.
ProfileViews Integer Total number of unique accounts that have viewed this profile within the specified period.
FollowerCount Integer Total number of unique accounts following this profile.
EmailContacts Integer Total number of taps on the email link in this profile.
PhoneCallClicks Integer Total number of taps on the call link in this profile.
TextMessageClicks Integer Total number of taps on the text message link in this profile.
GetDirectionsClicks Integer Total number of taps on the directions link in this profile.
Websiteclicks Integer Total number of taps on the website link in this profile.
Period String The period for the insight. This controls how rows will be broken up (by day, week, 28 days, or lifetime). This must always be specified.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountMediaProductType

It returns the number of POSTs and IGTVs during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the =, and IN operators.

The default query returns results for the 'reach' metric.

SELECT * FROM AccountMediaProductType
SELECT * FROM AccountMediaProductType WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'

To retrieve the result for other available metric, then explicitly specify the Metric in where clause. For example:

SELECT * FROM AccountMediaProductType WHERE Metric = 'total_interactions'
SELECT * FROM AccountMediaProductType WHERE Metric = 'likes'
SELECT * FROM AccountMediaProductType WHERE Metric = 'comments'
SELECT * FROM AccountMediaProductType WHERE Metric = 'saves'
SELECT * FROM AccountMediaProductType WHERE Metric = 'shares'
SELECT * FROM AccountMediaProductType WHERE Metric IN ('total_interactions', 'likes', 'comments', 'saves', 'shares')
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
Metric String Metric Type. Default value is reach. The allowed values are reach, total_interactions, likes, comments, saves, shares.
POST Int Number of POSTs.
IGTV Int Number of IGTVs.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountTimeSeriesFollowType

It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the = operator.

The default query returns results for the 'reach' metric.

SELECT * FROM AccountTimeSeriesFollowType
SELECT * FROM AccountTimeSeriesFollowType WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
Metric String Metric Type. The supported Metric types are reach, impressions, website_clicks, profile_views. The default metric type is reach.
EndTime Datetime End time.
Value Integer Total values of the metrics.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountTimeSeriesMediaProductType

It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the = operator.

The default query returns results for the 'reach' metric.

SELECT * FROM AccountTimeSeriesMediaProductType
SELECT * FROM AccountTimeSeriesMediaProductType WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
Metric String Metric Type. The supported Metric types are reach, impressions website_clicks, profile_views. The default metric type is reach.
EndTime Datetime End time.
Value Integer Total values of the metrics.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountTimeSeriesWithoutBreakdown

It returns the metric endtime and the value. For this view, the Metric type is time_series. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the = operator.

The default query returns results for the 'impressions' metric.

SELECT * FROM AccountTimeSeriesWithoutBreakdown
SELECT * FROM AccountTimeSeriesWithoutBreakdown WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
Metric String Metric Type. The supported Metric types are impressions, website_clicks, profile_views, reach. The default metric type is impressions.
EndTime Datetime End time.
Value Integer Total values of the metrics.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AccountWithoutBreakdown

It returns the total values of the metric type in Instagram. For eg, if the metric type is impressions, it will return the number of times your posts, stories, reels, videos and live videos were on screen, including in ads. For this view, the Metric Type is total_value. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.

  • Metric supports the =, and IN operators.

The default query returns results for the 'impressions' metric.

SELECT * FROM AccountWithoutBreakdown
SELECT * FROM AccountWithoutBreakdown WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'

To retrieve the result for other available metric, then explicitly specify the Metric in where clause. For example:

SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'accounts_engaged'
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'replies'
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'website_clicks'
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'profile_views'
SELECT * FROM AccountWithoutBreakdown WHERE Metric IN ('accounts_engaged', 'replies', 'website_clicks', 'profile_views')
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
TotalValue Int Total values of the metrics.
Metric String Metric Type. The supported Metric types are impressions, accounts_engaged, replies, website_clicks, profile_views, total_interactions, reach, likes, comments, saves, shares, follows_and_unfollows, profile_links_taps. The default metric type is impressions.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

AudienceInsights

Retrieve follower insights for an Instagram business account.

Select

By default this table returns the following:

  • The countries of this profile's followers.

To return any of the below demographic information about your followers:

  • The gender and age distribution of this profile's followers.
  • The locales of this profile's followers, by country code.
  • The cities of this profile's followers.

you will need to filter on the AudienceType column:

SELECT * FROM AudienceInsights WHERE AudienceType='country'
SELECT * FROM AudienceInsights WHERE AudienceType IN ('city','country','genderandage')

The above query will return follower counts broken down by city, follower counts broken down by country, and follower counts broken down by gender and age.

Valid values for the AudienceType column are:

  • city
  • country
  • gender
  • age
  • genderandage
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.
AudienceType String The type of followers breakdown. Possible values: city, country, gender, age, genderandage.
AudienceGroup String The breakdown value for followers.
TotalAudience Integer The total number of followers.
Description String The total number of the followers for this profile who were online during the specified period.
Timeframe String The earliest time for insight data to have been collected. Possible values: last_14_days, last_30_days, last_90_days, prev_month, this_month, this_week.

IGMedia

This View Represents an Instagram Photo, Video, Story, Album, or IGTV media.

Select

The connector will use the Instagram API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • Id supports the = operator.

For example, the following query is processed server side:

SELECT * FROM IGMedia WHERE ID = '1234'
Columns
Name Type Description
Id [KEY] String Media ID.
IGId String Instagram media ID.
Caption String Caption for the IGMedia.
CommentsCount Integer Count of comments on the media.
IsCommentEnabled Boolean Indicates if comments are enabled or disabled. Excludes album children.
LikeCount Integer Count of likes on the media.
MediaProductType String Surface where the media is published.
MediaType String Media type.
MediaUrl String Media URL.
Owner String ID of Instagram user who created the media.
PermanentURL String Permanent URL to the media.
ShortCode String Shortcode to the media.
ThumbnailUrl String Media thumbnail URL.
Timestamp Datetime ISO 8601 formatted creation date in UTC.
Username String Username of user who created the media.
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.

InstagramBusinessProfile

Get information about the Instagram Business account. Requires the instagram_basic scope, business_management, manage_pages .

Select

The connector will process all filters on this table client-side within itself.

Columns
Name Type Description
InstagramBusinessAccountId [KEY] String The unique identifier of the Instagram business account
UserName String The username of the person.
FullName String The full name of the person.
ProfilePictureUrl String The profile picture of the person.
Bio String The bio of the person.
Website String The website of the person.
MediaCount Integer The media count of the profile.
FollowsCount Integer The follows count of the profile.
FollowersCount Integer The followers count of the profile.

InstagramPages

Query information about pages connected to the Facebook account. Requires the instagram_basic scope.

Select

The connector will process all filters client-side within itself. You can use this table to obtain the value of the BusinessAccountId connection property:

SELECT Name, InstagramBusinessAccountId FROM Pages
Columns
Name Type Description
Id [KEY] String The unique identifier for the pages.
Name String The unique identifier for the instagram.
InstagramBusinessAccountId String The unique identifier for the instagram.
AccessToken String Access Token

Media

Query media objects. Requires the instagram_basic and instagram_content_publish scopes.

Select

The connector will use the Instagram APIs to process filters by ID and will process other filters client-side within itself.

The following query gets all media published by the authenticated user:

SELECT * FROM Media

To retrieve a single media object, the ID is required. The ID column supports the = operator. For example:

SELECT * FROM Media WHERE ID = '1501471279105199430_5380790872'
Columns
Name Type Description
Id [KEY] String The unique identifier for the media object.
InstagramBusinessAccountId String The unique identifier of the Instagram business account Id.
Username String The username.
MediaType String The type of media (image or video or reels or carousel).
MediaProductType String The Surface where the media is published Can be AD, FEED, STORY or REELS.
Caption String The caption for the media. Excludes carousel children.
CommentsCount Integer The number of comments.
LikesCount Integer The number of likes.
Mediaurl String The video URL of the media.
Link String The link of the media.
Created Datetime The time when the media was created.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for media object creation.
ToDateTime Datetime The latest time for media object creation.

MediaInsightReels

Allows you to get insights for reel media object. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

  • Reach
  • Comments
  • Likes
  • Saved
  • Plays
  • Shares
  • TotalInteractions

The connector will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

  • MediaInsightReels will only return the result of reels object.

  • Return results for the following metrics, saved for all the reels objects: Reach, Saved, Comments, Likes, Plays, Shares and TotalInteractions.

         SELECT * FROM MediaInsightReels WHERE MediaId = 17905513811523370"
    
         SELECT Reach, Saved, Comments, Likes, Plays, Shares, TotalInteractions FROM MediaInsightReels WHERE MediaId = 17905513811523370
    
Columns
Name Type Description
MediaId String The unique identifier of the insight.
Reach Integer Total number of unique accounts that have seen the media object.
Saved Integer Total number of unique accounts that have saved the media object.
Comments Integer Total number of unique accounts that have Comments on the media object.
Likes Integer Total number of unique accounts that have likes the media object.
Plays Integer Total number of unique accounts that have plays the media object.
Shares Integer Total number of unique accounts that have Shared the media object.
TotalInteractions Integer Total number of unique accounts that involved in the media object.
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.

MediaInsights

Allows you to get insights for an individual media object. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

  • Impressions
  • Engagement (likes, comments, and saves, only on version < 18.0)
  • TotalInteractions (likes, comments, shares, and saves, only on version >= 18.0)
  • Reach
  • Saved
  • Videoviews (only on a video object)
  • Replies (only on a story object)

The connector will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

  • MediaInsights will return result of all media objects except reels object.

  • Return results for the following metrics, saved for all the image and carousel objects: impressions, engagement, and reach.

    SELECT * FROM MediaInsights
    
  • Query the MediaInsights view using a different object, for example, videos.

    SELECT Impressions, Engagement, Reach, Saved, VideoViews FROM MediaInsights WHERE MediaId = "1321555648546465"
    
Columns
Name Type Description
MediaId String The unique identifier of the insight.
Impressions Integer Total number of times the media object has been seen.
TotalInteractions Integer Total number of likes, comments, saves, and shares on the media object.
Reach Integer Total number of unique accounts that have seen the media object.
Saved Integer Total number of unique accounts that have saved the media object.
VideoViews Integer Total number of unique accounts that have viewed the video.
Replies Integer Total number of unique accounts that have replied.
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.

MediaInsightsPost

Allows you to get insights for an individual media object for image and video POSTs. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

  • Comments
  • Follows
  • Likes
  • ProfileActivity
  • ProfileVisits
  • Shares
  • TotalInteractions

The connector will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

  • Return results for the following metrics, saved for all the POSTs image and video objects: Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares and TotalInteractions.

         SELECT * FROM MediaInsightsPost WHERE MediaId = 17945732813652602"
    
         SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsPost WHERE MediaId = 17945732813652602
    
Columns
Name Type Description
MediaId String The unique identifier of the insight.
Comments Integer The number of comments on your post.
Follows Integer The number of accounts that started following you.
Likes Integer The number of likes on your post.
ProfileActivity Integer The number of actions people take when they visit your profile after engaging with your post.
ProfileVisits Integer The number of times your profile was visited.
Shares Integer The number of shares of your post.
TotalInteractions Integer The number of likes, saves, comments and shares on your post minus the number of unlikes, unsaves and deleted comments.

MediaInsightsPostAlbum

Allows you to get insights for an individual media object for carousel album POSTs. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

  • TotalInteractions

The connector will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

  • Return results for the following metrics, saved for all the POSTs carousel album objects: TotalInteractions.

         SELECT * FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602"
    
         SELECT TotalInteractions FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602
    
Columns
Name Type Description
MediaId String The unique identifier of the insight.
TotalInteractions Integer The number of likes, saves, comments and shares on your post minus the number of unlikes, unsaves and deleted comments.

MediaInsightsStory

Allows you to get insights for an individual media object for Story. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

  • Follows
  • ProfileActivity
  • ProfileVisits
  • Shares
  • TotalInteractions
  • TapsForward (only on version < 18.0)
  • TapsBack (only on version < 18.0)
  • Exits (only on version < 18.0)
  • Navigation (only on version >= 18.0)

The connector will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself. Please note that following the nature of Stories on Instagram, insights and metrics related to stories expire after 24 hours.

  • Return results for the following metrics, saved for all the Story objects: Follows, ProfileActivity, ProfileVisits, Shares and TotalInteractions.

         SELECT * FROM MediaInsightsStory WHERE MediaId = 17945732813652602"
    
         SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsStory WHERE MediaId = 17945732813652602
    
Columns
Name Type Description
MediaId String The unique identifier of the insight.
Impressions Integer Total number of times the media object has been seen.
Reach Integer Total number of unique accounts that have seen the media object.
Follows Integer The number of accounts that started following you.
ProfileActivity Integer The number of actions people take when they visit your profile after engaging with your story.
ProfileVisits Integer The number of times your profile was visited.
Shares Integer The number of times your profile was visited.
TotalInteractions Integer The number of replies and shares for your story.
Navigation Integer Total number of actions taken from your story such as exits, taps forward, and taps back.

OnlineFollowers

Query Online Followers insights as hourly totals. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can use the FromDateTime and ToDateTime columns to filter the results by a timeframe. The connector uses the Instagram API to process filters that refer to a timeframe or ID and will process other filters client-side within itself.

  • The default query returns results as hourly totals during the last 7 days.

    SELECT * FROM OnlineFollowers
    
  • The maximum timeframe you can specify with the FromDateTime and ToDateTime columns is 30 days (2592000 s).

    SELECT * FROM OnlineFollowers WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30'
    
Columns
Name Type Description
InstagramBusinessAccountId String The unique identifier for the business account.
StartTime Datetime The start datetime of the insight.
EndTime Datetime The end datetime of the insight.
Onlinefollowers Integer The number of the online followers at the specific time.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDateTime Datetime The earliest time for insight data to have been collected.
ToDateTime Datetime The latest time for insight data to have been collected.

Pages

Get details of Pages. Requires a custom OAuth app with 'pages_read_engagement' permission or the 'Page Public Content Access' feature or the 'Page Public Metadata Access' feature.

Table Specific Information
Select

For information on how to create a custom OAuth app, please see Creating a Custom OAuth App. Please refer to Instagram's latest documentation for information on how to get this view's requisite permissions for a custom OAuth app.

The connector will use the Instagram API to process WHERE clause conditions built with the following column and operator. The SearchTerms is required to make a request and the rest of the filter is executed client side within the connector.

  • SearchTerms supports the '=' comparison.

For example:

SELECT * FROM Pages WHERE SearchTerms = 'facebook'
Columns
Name Type Description
Id [KEY] String The ID of the Facebook Page.
EligibleForBrandedContent Boolean Display whether the Facebook Page is eligible to post branded content.
IsUnclaimed Boolean Display whether a Facebook Page that was automatically generated has been claimed by the business it represents.
Link String The link to the Facebook Page.
City String The city where the business represented by the Facebook Page is located.
Country String The country where the business represented by the Facebook Page is located.
Latitude Double The latitude of the business represented by the Facebook Page.
Longitude Double The longitude of the business represented by the Facebook Page.
State String The state where the business represented by the Facebook Page is located.
Street String The street on which the business represented by the Facebook Page is located.
Zip Integer The postal code of the business represented by the Facebook Page.
Name String The name of the Facebook Page.
VerificationStatus String The verification status of the Facebook Page that represents a business.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
SearchTerms String The term that is to be searched.

Permissions

Query the Permissions the User has granted the current application.

Select

To query the Permissions view.

SELECT * FROM Permissions
Columns
Name Type Description
PermissionName [KEY] String The name of the permission.
Status String The status of the requested permission.

Stories

Query Stories. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The connector process all filters on this table client-side within itself.

Columns
Name Type Description
Id [KEY] String The unique identifier for the story.
InstagramBusinessAccountId String The unique identifier of the Instagram business account Id.

Tags

Query tags. Requires the instagram_basic and instagram_manage_comments scopes.

Select

The connector processes all filters on this table client-side within itself.

Columns
Name Type Description
Id [KEY] String The unique identifier for the tag.
Username String The unique identifier for the user.
Caption String The caption for the tag.
ComentsCount Int The number of coments.
LikeCount Int The number of likes.
MediType String The type of media (image or video).
MediUrl String The media URL.
UserId String The ID of the user.
Timestamp Datetime Time the media was created.
InstagramBusinessAccountId String The unique identifier for the Instagram business account.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Instagram.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Instagram, along with an indication of whether the procedure succeeded or failed.

Instagram Connector Stored Procedures

Name Description
GetOAuthAccessToken Gets the OAuth access token from Instagram.
GetOAuthAuthorizationURL Gets the Instagram authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to Instagram.
RefreshOAuthAccessToken Refreshes the OAuth token.

GetOAuthAccessToken

Gets the OAuth access token from Instagram.

Input
Name Type Description
AuthMode String The type of authentication mode to use. The allowed values are APP, WEB.
Verifier String The verifier token returned by Instagram after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode.
Scope String The scope or permissions you are requesting.
CallbackUrl String The URL the user will be redirected to after authorizing your application.
State String This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Instagram.
ExpiresIn String The remaining lifetime for the access token in seconds.

GetOAuthAuthorizationURL

Gets the Instagram authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to Instagram.

Input
Name Type Description
CallbackUrl String The URL that Instagram will return to after the user has authorized your app.
Scope String The scope or permissions you are requesting.
State String This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
URL String The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with.

RefreshOAuthAccessToken

Refreshes the OAuth token.

Input
Name Type Description
OAuthRefreshToken String The refresh token returned when the OAuth Token was first created.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Instagram.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Instagram:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Users table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Users'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the Merge stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='Merge' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Users table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Users'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:instagram:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information
Columns
Name Type Description
Product String The name of the product.
Version String The version number of the product.
Datasource String The name of the datasource the product connects to.
NodeId String The unique identifier of the machine where the product is installed.
HelpURL String The URL to the product's help documentation.
License String The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location String The file path location where the product's library is stored.
Environment String The version of the environment or rumtine the product is currently running under.
DataSyncVersion String The tier of Sync required to use this connector.
DataSyncCategory String The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Property Description
BusinessAccountId The ID of a connected Instagram business account Id.
Version The Facebook Graph API version to use.
AuthenticateAsPage true or false to authenticate for page accesstoken as when making requests to Instagram.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Instagram.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
BusinessAccountId The ID of a connected Instagram business account Id.
Version The Facebook Graph API version to use.
AuthenticateAsPage true or false to authenticate for page accesstoken as when making requests to Instagram.

BusinessAccountId

The ID of a connected Instagram business account Id.

Data Type

string

Default Value

""

Remarks

The ID of an Instagram business account connected to a Facebook page. Set this only if you have more than one Instagram business account managed with the same Facebook account.

Version

The Facebook Graph API version to use.

Data Type

string

Default Value

19.0

Remarks

The Facebook Graph API version to use. Generally this property does not need to be set.

AuthenticateAsPage

true or false to authenticate for page accesstoken as when making requests to Instagram.

Data Type

bool

Default Value

false

Remarks

true or false to authenticate for page accesstoken. The page must be managed by the authenticated user.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\Instagram Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\Instagram Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."
  • Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\Instagram Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\Instagram Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Instagram.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

Pagesize

The maximum number of results to return per page from Instagram.

Data Type

int

Default Value

0

Remarks

The Pagesize property affects the maximum number of results to return per page from Instagram. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Users WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.