Matillion ETL Data Model for SurveyMonkey
Version - 22.0.8257.0

Note: Data models are true for the latest version of Matillion ETL. If you are on an older version or using a component from an old job, your experience may differ.

Connection String OptionsBack To Top

  1. AuthScheme
  2. AccessToken
  3. InitiateOAuth
  4. OAuthClientId
  5. OAuthClientSecret
  6. OAuthAccessToken
  7. OAuthSettingsLocation
  8. CallbackURL
  9. Scope
  10. OAuthVerifier
  11. AccessURL
  12. OAuthRefreshToken
  13. OAuthExpiresIn
  14. OAuthTokenTimestamp
  15. SSLServerCert
  16. FirewallType
  17. FirewallServer
  18. FirewallPort
  19. FirewallUser
  20. FirewallPassword
  21. ProxyAutoDetect
  22. ProxyServer
  23. ProxyPort
  24. ProxyAuthScheme
  25. ProxyUser
  26. ProxyPassword
  27. ProxySSLType
  28. ProxyExceptions
  29. Logfile
  30. Verbosity
  31. LogModules
  32. MaxLogFileSize
  33. MaxLogFileCount
  34. Location
  35. BrowsableSchemas
  36. Tables
  37. Views
  38. AutoCache
  39. CacheDriver
  40. CacheConnection
  41. CacheLocation
  42. CacheTolerance
  43. Offline
  44. CacheMetadata
  45. BatchSize
  46. ConnectionLifeTime
  47. ConnectOnOpen
  48. MaxRows
  49. Other
  50. Pagesize
  51. PoolIdleTimeout
  52. PoolMaxSize
  53. PoolMinSize
  54. PoolWaitTime
  55. PseudoColumns
  56. RTK
  57. ShowCustomVariables
  58. Timeout
  59. UseConnectionPooling
  60. UserDefinedViews
  61. UseSimpleNames

AuthScheme

Data Type

string

Default Value

"OAuth"

Remarks



AccessToken

Data Type

string

Default Value

""

Remarks

The Access Token of the SurveyMonkey application.



InitiateOAuth

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 driver. 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 driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.



OAuthClientId

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

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

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

Data Type

string

Default Value

"%APPDATA%\\CData\\SurveyMonkey Data Provider\\OAuthSettings.txt"

Remarks

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

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\\CData\\SurveyMonkey Data Provider\\OAuthSettings.txt" 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



CallbackURL

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.



Scope

Data Type

string

Default Value

""

Remarks

The Scope supplied from the app settings. Recommended to be specified when using a custom app.



OAuthVerifier

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 Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH 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.



AccessURL

Data Type

string

Default Value

""

Remarks

The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account. By default takes the value returned when performing the GetOAuthAccessToken procedure. Change this if you are using the AccessToken AuthScheme and your accounts datacenter AccessURL is different from https://api.surveymonkey.net.



OAuthRefreshToken

Data Type

string

Default Value

""

Remarks

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



OAuthExpiresIn

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.



OAuthTokenTimestamp

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.



SSLServerCert

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.



FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type Default Port Description
TUNNEL 80 When this is set, the driver opens a connection to SurveyMonkey and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.



FirewallServer

Data Type

string

Default Value

""

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.



FirewallPort

Data Type

int

Default Value

0

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.



FirewallUser

Data Type

string

Default Value

""

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.



FirewallPassword

Data Type

string

Default Value

""

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.



ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.



ProxyServer

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.



ProxyPort

Data Type

int

Default Value

80

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.



ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.



ProxyUser

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats: 

user@domain

domain\user



ProxyPassword

Data Type

string

Default Value

""

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.



ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.



ProxyExceptions

Data Type

string

Default Value

""

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.



Logfile

Data Type

string

Default Value

""

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to: 

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.



Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.



LogModules

Data Type

string

Default Value

""

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.



MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.



MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.



Location

Data Type

string

Default Value

"%APPDATA%\\CData\\SurveyMonkey Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.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%\\CData\\SurveyMonkey 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

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

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

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

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

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.



AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

See Also



CacheDriver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined by the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note: you must add the CacheDriver JAR file to the classpath.

Examples
The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.
Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath: 

jdbc:surveymonkey:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following: 
jdbc:surveymonkey:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;
SQLite

The following is a JDBC URL for the SQLite JDBC driver: 

jdbc:surveymonkey:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;
MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL: 

  jdbc:surveymonkey:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;
SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server: 

jdbc:surveymonkey:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;
Oracle

The following is a JDBC URL for the Oracle Thin Client: 

jdbc:surveymonkey:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver: 

jdbc:surveymonkey:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;



CacheConnection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax: 

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following: 
jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL: 

jdbc:sqlite:dataSource

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL: 

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax: 

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example: 
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver: 

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example: 
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver: 

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432): 
jdbc:postgresql:postgres
The following are typical connection properties:



CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\SurveyMonkey Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

If left unspecified, the default location is "%APPDATA%\\CData\\SurveyMonkey Data Provider" 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

See Also



CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.



Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.



CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the SurveyMonkey catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata



BatchSize

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.



ConnectionLifeTime

Data Type

int

Default Value

0

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.



ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to SurveyMonkey when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to SurveyMonkey and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).



MaxRows

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.



Other

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.

Caching Configuration

CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.



Pagesize

Data Type

int

Default Value

100

Remarks

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



PoolIdleTimeout

Data Type

int

Default Value

60

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.



PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.



PoolMinSize

Data Type

int

Default Value

1

Remarks

The minimum number of connections in the pool. The default is 1.



PoolWaitTime

Data Type

int

Default Value

60

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.



PseudoColumns

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, "*=*".



RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.



ShowCustomVariables

Data Type

bool

Default Value

true

Remarks

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.



Timeout

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 driver throws an exception.



UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.



UserDefinedViews

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The driver 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 driver.

This User Defined View configuration file is formatted as follows:

For example: 

{

	"MyView": {

		"query": "SELECT * FROM MySurvey_Responses 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"



UseSimpleNames

Data Type

bool

Default Value

false

Remarks

SurveyMonkey tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the driver easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.





ViewsBack To Top

  1. CollectorMessages
  2. CollectorRecipients
  3. Collectors
  4. CollectorStats
  5. ContactLists
  6. Contacts
  7. Pages
  8. RollupQuestions
  9. Rollups
  10. SurveyQuestions
  11. SurveyResponses
  12. Surveys

CollectorMessages

Shows information regarding messages sent from a collector.

Table Specific Information
Select

You must specify the collector Id to query from this view. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side: 

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200'



SELECT * FROM CollectorMessages WHERE CollectorId = '175305200' AND Id = '57071816'
Columns

Name Type Description
Id [KEY] String The Id of the message.
CollectorId String The Id of the collector this message belongs to.
Status String The status of this message.
Type String Message type: 'invite', 'reminder', or 'thank_you'.
Subject String The subject of this message. Only available if resource is being queried by Id.
Body String The html body of this message. Only available if resource is being queried by Id.
DateCreated Datetime Date message was created. Only available if resource is being queried by Id.
ScheduledDate Datetime Date message is scheduled to be sent. If Null, message has not been scheduled to send. Only available if resource is being queried by Id.
EmbedFirstQuestion Boolean Whether to embed the first question to the message. Only available if resource is being queried by Id.
EditMessageLink String The link to the resource to edit this message. Only available if resource is being queried by Id.
IsBrandingEnabled Boolean Whether branding is enabled for this message. Only available if resource is being queried by Id.
IsScheduled Boolean Whether this message is scheduled. Only available if resource is being queried by Id.
RecipientStatus String Recipient filter: 'reminder' or 'thank_you'. Only available if resource is being queried by Id.



CollectorRecipients

Shows information regarding recipients of all or specific messages sent from a collector.

Table Specific Information
Select

You must specify the collector Id to query from this view. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side: 

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200'



SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND MessageId = '57071816'



SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND Id = '4496877899'
Columns

Name Type Description
Id [KEY] String The Id of the recipient.
CollectorId String The Id of the collector this recipient belongs to.
MessageId String The Id of the message this recipient belongs to. Null if it doesn't belong to a specific message.
Email String Email of recipient added to collector.
SurveyResponseStatus String If the recipient has completed the survey: 'not_responded', 'partially_responded', 'completely_responded'.
MailStatus String If an invite message to the recipient has been: 'sent', 'not_sent', or is 'processing'.
SurveyLink String Link to the survey in the invite.
RemoveLink String Unsubscribe link.



Collectors

Shows collector information.

Table Specific Information
Select

You must specify the survey Id or the collector Id to query from this view. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side: 

SELECT * FROM Collectors WHERE SurveyId = '126748712'



SELECT * FROM Collectors WHERE Id = '175305200'
Columns

Name Type Description
Id [KEY] String The Id of the collector.
SurveyId String The Id of the Survey this collector belongs to. Only shows up if filtering Collectors by SurveyId.
Name String The name of the collector.
Status String Collector status: 'open' or 'closed'. Only available if resource is being queried by Id.
Type String Collector type: 'weblink' or 'email'. Only available if resource is being queried by Id.
ThankYouMessage String Message for thank you page. Only available if resource is being queried by Id.
DisqualificationMessage String Message for disqualification page. Only available if resource is being queried by Id.
ClosedPageMessage String Message shown when someone visits a closed survey. Only available if resource is being queried by Id.
DisplaySurveyResults Boolean Shows respondents survey instant results when they complete the survey. Only available if resource is being queried by Id.
EditResponseTypes String When respondents can edit their response: 'until_complete', 'never', or 'always'. Only available if resource is being queried by Id.
AnonymousType String Turns off IP tracking. For email collectors, also removes respondent email address and name from response: 'not_anonymous', 'partially_anonymous', 'fully_anonymous'. Only available if resource is being queried by Id.
SenderEmail String Sender email for email collectors. User's email is used if null. Only available if resource is being queried by Id.
Url String If collector is a Web Collector (type 'weblink') then the url for the collector. Only available if resource is being queried by Id.
RedirectType String Determines survey end page behavior: url (redirects to URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), close (closes the survey window or tab), or loop (loops the survey back to the beginning, only available for weblink collectors with allow_multiple_responses:true). Only available if resource is being queried by Id.
RedirectUrl String Redirects respondent to this url upon survey completion. Only available if resource is being queried by Id.
AllowMultipleResponses Boolean Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors. Only available if resource is being queried by Id.
PasswordEnabled Boolean True if the collector is password protected. Only available for weblink collectors. Only available if resource is being queried by Id.
DateModified Datetime Date collector was last modified. Only available if resource is being queried by Id.
DateCreated Datetime Date collector was created. Only available if resource is being queried by Id.
CloseDate Datetime Close date of collector. Only available if resource is being queried by Id.



CollectorStats

Shows statistics regarding all or specific messages sent from a collector.

Table Specific Information
Select

You must specify the collector Id to query from this view. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side: 

SELECT * FROM CollectorStats WHERE CollectorId = '175305200'



SELECT * FROM CollectorStats WHERE CollectorId = '175305200' AND MessageId = '57071816'
Columns

Name Type Description
CollectorId String The Id of the collector these statistics belongs to.
MessageId String The Id of the message these statistics belong to. Null if they don't belong to a specific message.
Recipients Integer Count of recipients included in the stats.
CompletelyResponded Integer Count of recipients who have completed a survey response.
NotResponded Integer Count of recipients who have not started the survey.
PartiallyResponded Integer Count of recipients who have begun the survey but not completed it.
Opened Integer Count of recipients that have opened the message.
OptedOut Integer Count of recipients that have clicked on the opt out link.
NotSent Integer Count of recipients that have been added but their message has not been delivered.
Sent Integer Count of recipients that messages have been sent to.
Bounced Integer Count of recipients with messages that bounced.
LinkClicked Integer Count of messages where the included survey link was clicked on.



ContactLists

Shows contact list information.

Select
The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side: 

SELECT * FROM ContactLists WHERE Id = '123740269'
Columns

Name Type Description
Id [KEY] String The Id of the contact list.
Name String The name of the contact list.



Contacts

Shows contact information.

Select
The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side: 

SELECT * FROM Contacts WHERE Id = '2842583326'



SELECT * FROM Contacts WHERE ContactListId = '123679423'
Columns

Name Type Description
Id [KEY] String The Id of the contact.
ContactListId String Use this to filter contacts only from the given ContactListId.
FirstName String The first name of the contact.
LastName String The last name of the contact.
Email String The email of the contact.
CustomField1 String The value of the first custom field for this contact.
CustomField2 String The value of the second custom field for this contact.
CustomField3 String The value of the third custom field for this contact.
CustomField4 String The value of the fourth custom field for this contact.
CustomField5 String The value of the fifth custom field for this contact.
CustomField6 String The value of the sixth custom field for this contact.



Pages

Shows information regarding pages for a survey.

Table Specific Information
Select

You must specify the survey Id for this view to see page information for the survey. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side: 

SELECT * FROM Pages WHERE SurveyId = '1231231'

 

SELECT * FROM Pages WHERE SurveyId = '1231231' AND Id = '1234567'
Columns

Name Type Description
Id [KEY] String The Id of the page.
SurveyId String The Id of the survey.
Title String The title of the page.
Description String The description of the page.
Position Integer The ordinal position of the page.
QuestionCount Integer The number of questions in this page.



RollupQuestions

Shows rolled up individual stats information for a survey.

Select

You must specify the survey Id for this view to see roll up stats for the survey. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side: 

SELECT * FROM RollupQuestions WHERE SurveyId = '1231231'
Columns

Name Type Description
SurveyId String The Id of the survey.
QuestionId String The Id of the question
ResponseCount Integer Number of people which answered by selecting this choice.
ResponseTextCount Integer Number of people which answered by writing in a text.
ChoiceId String The Id of the response.
Other Boolean Whether the selected choice was an other response.
Ordinal Int The number of the order this choice appears in the list of choices. Ordinals are used to get a meaningful representation for stats like maximum, minimum, average, median, and standard deviation.
Max Double The maximum value of the ordinals of the answered choices.
Min Double The minimum value of the ordinals of the answered choices.
Mean Double The average value of the ordinals of the answered choices.
Median Double The median value of the ordinals of the answered choices.
Std Double The standard deviation value of the ordinals of the answered choices.



Rollups

Shows rolled up stats information for a survey.

Table Specific Information
Select

You must specify the survey Id for this view to see roll up stats for the survey. The driver will execute other filters client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side: 

SELECT * FROM Rollups WHERE SurveyId = '1231231'
Columns

Name Type Description
SurveyId String The id of the survey.
QuestionId String The id of the question
Family String The family this question belongs to.
Subtype String The subtype this question belongs to.
Answered Integer Number of people who answered this question by picking one of the given choices.
AnsweredOther Integer Number of people who answered this question by picking the other option.
Skipped Integer Number of people who skipped this question.



SurveyQuestions

Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.

Select

To query the SurveyQuestions view, you must use the name of the survey and append '_Questions' to the end. With SupportEnhancedSQL set to true (the default), the driver will execute all filters to this table client-side in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false. 

SELECT * FROM [Volunteer Feedback Template_Questions]



SELECT * FROM [Benefits Template_Questions]
Columns

Name Type Description
SurveyId String The id of the survey.
QuestionId String The id of the question.
QuestionPosition Integer The position of that query in the Survey.
QuestionText String The text of the question.
QuestionFamily String The family of the question.
QuestionSubtype String The subtype of the question.
ChoiceId String The id of the choice.
ChoiceText String The text of the choice.
ChoiceWeight String The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore Int This field is dynamic and maps to the corresponding report field.
RowId String The id of the row.
RowText String The text of the row.
ColId String The id of the column.
ColText String The text of the column.
PageId String The id of the page.
PageTitle String The title of the page.



SurveyResponses

Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.

Select

To query the SurveyResponses view, you must use the name of the survey and append '_Responses' to the end.

The driver uses the SurveyMonkey APIs to filter results by the following columns and operators:

The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will not be filtered.

For example, the following queries are processed server side: 

SELECT * FROM [Volunteer Feedback Template_Responses]



SELECT * FROM [Benefits Template_Responses]



SELECT * FROM [Benefits Template_Responses] WHERE RespondentId = '1234567890'



SELECT * FROM [Benefits Template_Responses] WHERE RespondentId IN ('1234567890', '0987654321')



SELECT * FROM [Benefits Template_Responses] WHERE DateCreated > '2018-01-01' AND DateCreated < '2018-01-30'



SELECT * FROM [Benefits Template_Responses] WHERE QuestionId = '213965574'



SELECT * FROM [Benefits Template_Responses] WHERE QuestionId IN ('213965574', '213963957')



SELECT * FROM [Benefits Template_Responses] WHERE TotalTime > 5 AND TotalTime < 10 AND TotalTimeUnit='minute'



SELECT * FROM [Benefits Template_Responses] WHERE IpAddress = '192.168.0.1'



SELECT * FROM [Benefits Template_Responses] WHERE ResponseStatus = 'completed'

Note: When selecting a specific respondent, the aggregate column "Metadata" will be populated with a JsonObject and its elements can be accessed using the JSON_EXTRACT function in the SQLQuery.

Columns

Name Type Description
RespondentId String The id of the respondent, the person who answered this question.
SurveyId String The id of the survey.
RecipientId String The id of the recipient.
PageId String The id of the page.
QuestionId String The id of the question.
QuestionText String The text of the question.
ChoiceId String The id of the choice.
ChoiceText String The text of the choice.
ChoiceWeight String The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore Int This field is dynamic and maps to the corresponding report field.
IsCorrectChoice Boolean This field is dynamic and maps to the corresponding report field.
RowId String The id of the row.
RowText String The text of the row.
ColId String The id of the column.
ColText String The text of the column.
OtherId String The id of the other field.
OtherText String The text of the other field.
AnswerText String The text of the answer (in the case of an open-ended question).
CollectionMode String The mode of collection.
CollectorId String The id of the collector the response was taken for.
TotalTime String Total time spent on this survey.
ResponseStatus String The status of the response. Valid values are `completed`, `partial`, `overquota`, and `disqualified`.
DateCreated Datetime Date and time when survey was created.
DateModified Datetime Date and time when survey was last modified.
CustomValue Integer A custom value for this response.
EditUrl String Survey edit URL.
AnalyzeUrl String Survey analyze URL.
IpAddress String The IP address of the respondent.
QuizCorrectAnswers Int This field is dynamic and maps to the corresponding report field.
QuizIncorrectAnswers Int This field is dynamic and maps to the corresponding report field.
QuizPartiallyCorrectAnswers Int This field is dynamic and maps to the corresponding report field.
QuizTotalScore Int This field is dynamic and maps to the corresponding report field.
QuizTotalQuestions Int This field is dynamic and maps to the corresponding report field.
QuizMaxScore Int This field is dynamic and maps to the corresponding report field.

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
TotalTimeUnit String The unit of time you want to filter total time values with. Valids units are `second`, `minute`, and `hour`. If not specified, it will use `second` as a default value. This only affects the filtering on SurveyMonkey's end. The values returned for TotalTime from the API will still be in seconds despite what value is being sent for TotalTimeUnit.



Surveys

Shows information regarding surveys.

Columns

Name Type Description
Id [KEY] String The Id of the survey.
Title String The title of the survey.
Nickname String The nickname of the survey.
Category String The Category of the survey.
DateCreated Datetime The Date that the survey was created.
DateModified Datetime The Date that the survey was modified.
FolderId String If specified, adds the survey to the folder with that id.
IsOwner Boolean Is Owner of the survey.
Language String Language of the survey.
QuestionCount Int The number of questions in survey.
ResponseCount Int The number of responses survey has received.