Twilio Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8936 of the connector.

Get Started

Twilio Version Support

The connector uses the Twilio REST API.

Establish a Connection

Use the AccountSID and AuthToken connection properties to access data from your account. You obtain your live credentials on your Twilio account dashboard. Click Account -> Account Settings to obtain your test credentials.

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 Twilio 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 Twilio and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Twilio 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 Applications 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 Twilio connector models the Twilio API as relational tables and views. These are defined in schema files, which are simple, text-based configuration files.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

The connector models the data in tables so that it can be easily queried and updated with standard SQL.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Tables

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

Twilio Connector Tables

Accounts

Create, update, and query Twilio Accounts belonging to the authenticated Account.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Accounts are Name, Status, and Sid.

SELECT * FROM Accounts WHERE Name = 'test' AND Status = 'suspended'

Insert

To add an Account, specify the Name field.

INSERT INTO Accounts (Name) VALUES ('test1')

Update

Twilio allows updates for the Name and Status columns.

UPDATE Accounts SET Status = 'closed' WHERE Sid = 'X123456789'

Delete

Twilio does not allow Accounts to be deleted.

Columns

Applications

Create, update, delete, and query the available Applications in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Applications are Name and Sid.

SELECT * FROM Applications WHERE Sid = 'X123456789'

Insert

To add an Application, specify at least the Name.

INSERT INTO Applications (Name, VoiceUrl, VoiceFallbackUrl, VoiceFallbackMethod, StatusCallback, StatusCallbackMethod, VoiceCallerIdLookup,
SmsUrl, SmsMethod, SmsFallbackUrl, SmsStatusCallback, MessageStatusCallback) VALUES ('app7', 'http://demo.twilio.com/docs/voiceUrl.xml', 'http://demo.twilio.com/docs/voiceFallback.xml', 'POST', 'http://demo.twilio.com/docs/statusCallback.xml', 'POST', true, 'http://demo.twilio.com/docs/smsFallback.xml', 'POST', 'http://demo.twilio.com/docs/smsFallback.xml', 'http://demo.twilio.com/docs/smsStatusCallback.xml', 'http://demo.twilio.com/docs/voiceUrl.xml')

Update

UPDATE Applications SET Name='appp8' WHERE Sid= 'ACab6788889df1432ae'

Delete

DELETE FROM Applications WHERE Sid = 'ACab6788889df1432ae'

Columns

Calls

Delete and query connections between phones and Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Sid are From, To, StartTime, EndTime, ParentCallSid, and Sid. StartTime and EndTime can be used with the >, >=, <, <=, or = conditions.

SELECT * FROM Calls WHERE StartTime <= '2014-10-10' AND EndTime >= '2015-10-10'

Insert

Twilio does not allow Calls to be added.

Update

Twilio does not allow Calls to be updated.

Delete

DELETE FROM Calls WHERE Sid = 'CAcdc741bdcc2ae'

Columns

Feedback

Create and query Feedback on a Call in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available column for Feedback is only Sid and it is required in WHERE clause.

SELECT * FROM Feedback WHERE Sid = 'F123456789'

Insert

To add a CallFeedback, specify at least QualityScore and Sid. Column Issues is optional.

INSERT INTO Feedback (Sid, QualityScore) VALUES ('X95487143505', 1)

Update

Twilio does not allow Feedback records to be updated.

Delete

Twilio does not allow Feedback records to be deleted.

Columns

FeedbackSummary

Create, delete, and query Feedback Summaries in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. Only Sid is supported in the WHERE clause and it is required.

SELECT * FROM FeedbackSummary WHERE Sid = 'FS123456789'

Insert

To add a FeedbackSummary, specify at least these parameters: StartDate, EndDate, and IncludeSubaccounts.

INSERT INTO FeedbackSummary (StartDate, EndDate, IncludeSubaccounts) VALUES ('2014-06-01', '2014-06-30', true)

Update

Twilio does not allow FeedbackSummary to be updated.

Delete

DELETE FROM FeedbackSummary WHERE Sid = 'FS123456789'

Columns

IncomingPhoneNumbers

Create, update, delete, and query phone numbers purchased from Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbers are PhoneNumber, Name, Beta, and Sid.

SELECT * FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'

Insert

To add an IncomingPhoneNumber, specify exactly one of the following parameters: PhoneNumber or AreaCode. If you include both parameters, Twilio will use the AreaCode parameter and ignore the PhoneNumber provided.

INSERT INTO IncomingPhoneNumbers (PhoneNumber, AreaCode) VALUES ('+15105555555', '123')

Update

UPDATE IncomingPhoneNumbers SET Name='appp8' WHERE Sid= 'X123456789'

Delete

DELETE FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'

Columns

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.

Media

Delete and query Media in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The MessageSid column is required in the WHERE clause; Sid can be used with the = conditions and DateCreated is optional and can be used with the >, >=, <, <=, or = conditions.

SELECT * FROM Media WHERE MessageSid = 'SM53a7aeeed5ac474ea'

SELECT * FROM Media WHERE Sid = 'MS123456789' AND MessageSid = 'SM53a7aeeed5ac474ea'

SELECT * FROM Media WHERE Sid = 'MS123456789' AND MessageSid = 'SM53a7aeeed5ac474ea' AND DateCreated > '2015-10-10'

Insert

Twilio does not allow Media to be added.

Update

Twilio does not allow Media to be updated.

Delete

DELETE FROM Media WHERE MessageSid='MM319a82ae6d7411407ef7dc7d78eb2081' AND Sid='MS123456789'

Columns

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.

Messages

Create, update, delete, and query SMS and MMS Messages in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Messages are Sender, To, DateSent, and Sid. DateSent may be used with the >, >=, <, <=, or = conditions.

SELECT * FROM Messages WHERE Sid = 'MS123456789' AND DateSent > '2015-10-10'

Insert

To add a Message, specify Body, MediaUrl, or both, and To. At least one of the following conditional parameters must also be included: MessagingServiceSid or Sender.

INSERT INTO Messages (To, Sender, Body) VALUES ('+12345678965', '+12019493653', 'Hi!')

INSERT INTO Messages (To, Sender, MediaUrl) VALUES ('+12345678965', '+12019493653', 'http://www.mycompany.com/ui/img/logo.png')

Note: Up to 10 MediaUrl can be added per message as comma-separated-values.

INSERT INTO Messages (To, Sender, Body, MediaUrl) VALUES ('+12345678965', '+12019493653', 'Hi again!', 'http://www.mycompany.com/ui/img/logo.png, http://www.mycompany.com/ui/img/logo2.png')

Update

To update a Message record, the Body column must be empty.

UPDATE Messages SET Body = "" WHERE Sid = 'M1233455'

Delete

Messages cannot be deleted if the status is sending.

DELETE FROM Messages WHERE Sid = 'M123456789'

Columns

OutgoingCallerIds

Insert, update, and query the verified numbers that may be used as a caller ID when making outgoing calls in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for OutgoingCallerIds are PhoneNumber, Name, and Sid.

SELECT * FROM OutgoingCallerIds WHERE Sid = 'X123456789'

Insert

To add an OutgoingCallerId use the AddOutgoingCallerIds stored procedure.

EXEC AddOutgoingCallerIds PhoneNumber = '+15105555555'

Update

Twilio allows the Name column to be updated.

UPDATE OutgoingCallerIds SET Name = 'test' WHERE Sid = 'O123456789'

Delete

Twilio does not allow OutgoingCallerIds to be deleted.

Columns

Recordings

Delete and query the available Recordings in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Recordings are CallSid, DateCreated, and Sid. DateCreated may be used with the >, >=, <, <=, or = conditions.

SELECT * FROM Recordings WHERE DateCreated > '2011-10-10'

Insert

Twilio does not allow Recordings to be added.

Update

Twilio does not allow Recordings to be updated.

Delete

DELETE FROM Recordings WHERE Sid='REfb1f22afc4f6243242'

Columns

ServiceLists

Create, update, delete, and query the available Lists for a specific Service in Twilio Sync.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for ServiceLists are Sid, and ServiceSid.

SELECT * FROM ServiceLists WHERE Sid = 'ES5efaf437f5274d89a79' AND ServiceSid = 'ISbd3a2af64'

SELECT * FROM ServiceLists WHERE ServiceSid = 'ISbd3a2af64'

Insert

To add a ServiceList, specify at least the ServiceSid and UniqueName.

INSERT INTO ServiceLists (ServiceSid, UniqueName) VALUES ('ISbd3a2af64e5c39', 'Denis')

Update

UPDATE ServiceLists SET TimeToLive = 10 WHERE Sid='ES5efaf437f5274d89a79' AND ServiceSid='ISbd3a2af64'

Delete

DELETE FROM ServiceLists  WHERE Sid='ES5efaf437f5274d89a79' AND ServiceSid='ISbd3a2af64'

Columns

Transcriptions

Query the available Transcriptions in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Transcriptions are RecordingSid and Sid.

SELECT * FROM Transcriptions WHERE Sid = 'T12345564'

Insert

Twilio does not allow Transcriptions to be added.

Update

Twilio does not allow Transcriptions to be updated.

Columns

Triggers

Create, update, delete, and query usage Triggers in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Triggers are Category, TriggerBy, UsageCategory, and Sid.

SELECT * FROM Triggers WHERE Sid = 'X123456789'

Insert

To add a Trigger specify the UsageCategory, TriggerValue, and CallbackUrl. Other optional columns are Name, TriggerBy, Recurring, and CallbackMethod.

INSERT INTO Triggers (UsageCategory, TriggerValue, CallbackUrl, CallbackMethod, Name, Recurring, TriggerBy)
VALUES ('sms', 100, 'http://twilio.com/test', 'POST', 'trigger test', 'monthly', 'price')

Update

Triggers allow UPDATEs for the Name, CallbackUrl, and CallbackMethod columns.

UPDATE Triggers SET Name = 'updated' WHERE Sid = 'X123456789'

Columns

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.

Twilio Connector Views

AvailablePhoneNumbers

Query the local, mobile, and toll-free phone numbers available in Twilio.

Table Specific Information

You can use this table to search for local, toll-free, and mobile phone numbers that are available for you to purchase. You can search for phone numbers by specifying a pattern, country, area code (NPA) or exchange (NXX), or geography.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. IsoCountry and Category are required columns in the WHERE clause. Optional columns are AreaCode, CapabilitiesSms, CapabilitiesVoice, Beta, RateCenter, Lata, PostalCode, Distance, and PhoneNumber. PhoneNumber can be used with the LIKE condition.

SELECT * FROM AvailablePhoneNumbers WHERE IsoCountry = 'US' AND Category = 'Local'

Columns

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.

CallEvents

The call events resource provides programmatic access to call progress and SDK events for a provided call SID.

Table Specific Information

The call events resource provides metadata on SDK events for specific user over a call.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
Note: CallSid is required in order to query CallEvents.

SELECT * FROM CallEvents WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM Callevents WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Edge = 'sdk_edge'

Columns

CallMetrics

The call metrics resource provides an overview of metadata and quality metrics for a provided call.

Table Specific Information

The call metrics resource provides an overview of metadata and quality metrics for a provided call.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: CallSid is required in order to query CallMetrics.

SELECT * FROM CallMetrics WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM CallMetrics WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND edge = 'carrier_edge'

Columns

CallSummary

This resource provides an overview of metadata and quality metrics for a single call.

Table Specific Information

The call summary resource provides an overview of metadata and quality metrics for a single call, which contains all the metadata information related to that call.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: CallSid is required in order to query CallSummary.

SELECT * FROM CallSummary WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM CallSummary WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND ProcessingState = 'Partial'

Columns

ConversationMessages

ConversationMessage includes metadata of the Messages sent over a conversation.

Table Specific Information

Each Conversation includes a list of the Messages that they have sent amongst each other and an array of objects that describe the Message's media.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query ConversationMessages.

SELECT * FROM ConversationMessages WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM ConversationMessages WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'MGd452e64de7dff2465702495ed6048e84'

Columns

ConversationParticipants

Each participant in a Conversation represents one real (probably human) participant in a Conversation. it joins Participants with the conversation, and the connected person will receive all subsequent messages.

Table Specific Information

Each participant in a Conversation represents one real (probably human) participant in a Conversation. Participant joins with the conversation, and the connected person will receive all subsequent messages.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query ConversationPartiticipants.

SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'IS62451554b2b349d6a0bee0b047ead195'

Columns

Conversations

Conversation includes a list of current Participants and the Messages that they have sent amongst each other.

Table Specific Information

A Conversation is a unique thread of a conversation. each Conversation includes a list of current Participants and the Messages that they have sent amongst each other.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query Conversations.

SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'IS62451554b2b349d6a0bee0b047ead195'

SELECT * FROM Conversations where State = 'active'

SELECT * FROM Conversations where DateCreated = '2015-12-16T22:18:37' and DateUpdated = '2015-12-16T22:18:38'

Columns

IncomingPhoneNumbersCategory

Query Twilio Incoming Phone Numbers and filter by Category.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbersCategory are Category, PhoneNumber, Name, Beta, and Sid. The Category column must be specified in the WHERE clause.

SELECT * FROM IncomingPhoneNumbersCategory WHERE Category = 'Local'

Columns

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.

Services

A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Services is Sid.

SELECT * FROM Services

SELECT * FROM Services WHERE Sid = 'IS5834ff94f011bc4e627a3'

Columns

UsageRecords

Query Usage Records in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Triggers are Category, StartDate, EndDate, and Interval. StartDate and EndDate may be used with the >, >=, <, <=, or = conditions. Interval should be used as an escaped string, i.e [Interval].

SELECT * FROM UsageRecords WHERE [Interval] = 'Today'

Columns

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.

Stored Procedures

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

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

Twilio Connector Stored Procedures

AddOutgoingCallerIds

Adds a new CallerId to your account.

Input

Result Set Columns

SendMessage

Send outgoing SMS messages from your Twilio phone number to mobile phones around the globe.

Input

Result Set Columns

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 Twilio:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

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

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

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

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Applications'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns

sys_keycolumns

Describes the primary and foreign keys.

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

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Applications'

Columns

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

sys_primarykeys

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns

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

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:twilio: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

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.

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

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

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

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

SSL

Schema

Miscellaneous

Authentication

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

AuthToken

Auth token of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

Auth token of the currently authenticated user.

AccountSID

Account SID of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

Account SID of the currently authenticated user.

SSL

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

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:

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.

Location

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

Data Type

string

Default Value

%APPDATA%\Twilio 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%\Twilio Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

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.

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

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 Applications 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.