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

CompanyId

Data Type

string

Default Value

""

Remarks

This property must be set in the connection string or query. Otherwise, the driver will use the first found company Id.



APIVersion

Data Type

string

Default Value

"202210"

Remarks

The API version used by default is 202210. To use a different API version set this to the format YYYYMM.



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\\LinkedIn 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\\LinkedIn 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

This property must be set in the connection string to get a scoped token with specific privileges.



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.



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 LinkedIn 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\\LinkedIn 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\\LinkedIn 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:linkedin:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;CompanyId=XXXXXXX
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:linkedin:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;CompanyId=XXXXXXX
SQLite

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

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

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

  jdbc:linkedin: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;CompanyId=XXXXXXX
SQL Server

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

jdbc:linkedin: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;CompanyId=XXXXXXX
Oracle

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

jdbc:linkedin:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;CompanyId=XXXXXXX
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:linkedin: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;CompanyId=XXXXXXX



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



Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.



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.



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 CompanyStatusUpdates 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"





TablesBack To Top

  1. CompanyStatusUpdates

CompanyStatusUpdates

Lists update events from the LinkedIn company page.

Select

The CompanyStatusUpdates table supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example: 

SELECT * FROM CompanyStatusUpdates WHERE CompanyId='183432'
Columns

Name Type Description
Id [KEY] String The unique identifier for the update in the following format urn:li:organization:{id}.
Comment String Comment associated with update status.
CompanyId String Id of the Company associated with the update.
Date Datetime Update created time .
CreatedBy String Id of the person who created update.
FirstPublishedAt Datetime Time when update is published.
LastModified Datetime Last time when changes for this update are made.
Visibility String Visibility of the update.
LifecycleState String State of the update.





ViewsBack To Top

  1. Comments
  2. CompanyDetails
  3. CompanyFollowerStatistics
  4. CompanyList
  5. CompanyLocations
  6. CompanyPageStatistics
  7. CompanyStatusUpdates
  8. CompanyUpdateStatistics
  9. OrganizationFollowerCount
  10. Positions
  11. Profile

Comments

Query comments for a specific company update.

Select

The Comments view supports the UpdateId and CompanyId columns in the WHERE clause. The supported operator for these columns is =. For example: 

SELECT * FROM Comments WHERE Id='183432' AND UpdateId='UPDATE-12315-1352-112515'

SELECT * FROM Comments WHERE UpdateId='UPDATE-12315-1352-112515'

Make sure that, when selecting a specific update, comments are enabled on it.

Columns

Name Type Description
Id [KEY] String The unique identifier for the comment.
UpdateId String Id of the Update associated with the comment.
Text String Content of the update comment.
CreatedBy String The unique identifier for the person or company.
Date Datetime Comment created time.



CompanyDetails

Retrieve company profiles and updates.

Select

The CompanyDetails view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example: 

SELECT * FROM CompanyDetails

SELECT * FROM CompanyDetails WHERE CompanyId='183432'
Columns

Name Type Description
CompanyId [KEY] String The unique, internal, numeric identifier for the company in the following format urn:li:organization:{id}
CompanyName String The name of the company.
UniversalName String The unique string identifier for the company.
Description String The company description. Limit of 500 characters.
Specialties String The company specialties.
StaffCountRange String The company staff count range.
WebsiteUrl String The URL for the company website.
Logo String The original company logo.
SquareLogo String The square company logo.
CompanyTypeName String The name of the company type.
Groups String The groups of the company.
Industries String The industries of the company.
FoundedYear Integer The year the company was founded.
EndYear Integer The year listed for when the company closed or was acquired by another.
PrimaryOrganizationType String Type of primary organization being used in the lookup. Possible values: SCHOOL,BRAND,NONE
VanityName String Entity's unique name used in URLs.
VersionTag String Tag indicating version.



CompanyFollowerStatistics

Query statistics about followers for a particular company page.

Select

The CompanyFollowerStatistics view supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example: 

SELECT * FROM CompanyFollowerStatistics WHERE CompanyId='183432'
Columns

Name Type Description
CompanyId String Id of the Company associated with the follow statistics in the following format urn:li:organization:{id}.
Category String The category of the followers.
Type String Type of the category.
OrganicFollowerCount Integer Total number of the organinc followers.
PaidFollowerCount Integer Total number of the paid followers.
TimeGranularity String Granularity of the statistics. Must be either DAY or MONTH.
ReportTimeRangeStart Datetime Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd Datetime Inclusive ending timestamp of when the query should end. Queries until current time when not set.
UsageStartTime Datetime Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime Datetime Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.



CompanyList

Lists all companies and the privileges that the user has within the organization.

Select

The CompanyList view returns a list of all companies that the member is an administrator of. For example: 

SELECT * FROM CompanyList
Columns

Name Type Description
Id [KEY] String A unique identifier for the company in the following format urn:li:organization:{id}
RoleAssignee String Id of the assigned person.
Role String Role of the assigned person.
State String State of the company.



CompanyLocations

Retrieve company locations information.

Select

The CompanyLocations view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example: 

SELECT * FROM CompanyLocations

SELECT * FROM CompanyLocations WHERE CompanyId='183432'
Columns

Name Type Description
CompanyId [KEY] String Id of the Company associated with the comment in the following format urn:li:organization:{id}
Description String The company description. Limit of 500 characters.
LocationType String Type of the location.
Street1 String The first line of the street address for the company location.
Apartment String The number of the apatrment,suite etc. for the company location.
City String The city of the company location.
State String The state of the company location.
PostalCode String The postal code of the company location.
CountryCode String The country code of the company location.



CompanyPageStatistics

Query statistics about page views for a particular company page.

Select

The driver will use the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.

The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.

Columns

Name Type Description
CompanyId String Id of the Company associated with the page statistics in the following format urn:li:organization:{id}
Category String The category of the statistics.
Type String Type of the category. Not applicable for the totalPageStatistics category.
AllPageViews Integer Complete page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
AllDesktopPageViews Integer Complete desktop page views count.
AllMobilePageViews Integer Complete mobile page views count.
OverviewPageViews Integer Total Overview page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
CareersPageViews Integer Total Careers page views count.
DesktopCareersPageViews Integer Total desktop Careers page views count.
DesktopJobsPageViews Integer Total desktop Jobs page views count.
DesktopLifeAtPageViews Integer Total desktop Life Atpage views count.
DesktopOverviewPageViews Integer Total desktop Overview page views count.
JobsPageViews Integer Total Jobs page views count.
LifeAtPageViews Integer Total LifeAt page views count.
MobileCareersPageViews Integer Total mobile Careers page views count.
MobileJobsPageViews Integer Total mobile Jobs page views count.
MobileLifeAtPageViews Integer Total mobile LifeAt Page views count.
MobileOverviewPageViews Integer Total mobile Overview page views count.
MobileProductsPageViews Integer Total mobile Products page views count.
InsightsPageViews Integer Total Insights page views count.
MobileAboutPageViews Integer Total mobile About page views count.
ProductsPageViews Integer Total Products page views count.
DesktopProductsPageViews Integer Total desktop Products page views count.
PeoplePageViews Integer Total People page views count.
DesktopPeoplePageViews Integer Total desktop People page views count.
AboutPageViews Integer Total About page views count.
DesktopAboutPageViews Integer Total desktop About page views count.
MobilePeoplePageViews Integer Total mobile People page views count.
DesktopInsightsPageViews Integer Total desktop Insights page views count.
MobileInsightsPageViews Integer Total mobile Insights page views count.
MobileCareersPagePromoLinksClicks Integer Total mobile clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
MobileCareersPageJobsClicks Integer Total mobile clicks count on Careers page Jobs. Applicable only for the totalPageStatistics category.
MobileCareersPageEmployeesClicks Integer Total mobile clicks count on Careers page Employees. Applicable only for the totalPageStatistics category.
CareersPagePromoLinksClicks Integer Total clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
CareersPageBannerPromoClicks Integer Total clicks count on Careers page banner promo. Applicable only for the totalPageStatistics category.
CareersPageJobsClicks Integer Total clicks count on Careers page jobs. Applicable only for the totalPageStatistics category.
CareersPageEmployeesClicks Integer Total clicks count on Careers page employees. Applicable only for the totalPageStatistics category.
TimeGranularity String Granularity of the statistics. Must be either DAY or MONTH.
UsageStartTime Datetime Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime Datetime Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.
ReportTimeRangeStart Datetime Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd Datetime Inclusive ending timestamp of when the query should end. Queries until current time when not set.



CompanyStatusUpdates

Lists update events from the LinkedIn company page.

Select

The CompanyStatusUpdates table supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example: 

SELECT * FROM CompanyStatusUpdates WHERE CompanyId='183432'
Columns

Name Type Description
Id [KEY] String The unique identifier for the update in the following format urn:li:organization:{id}.
Comment String Comment associated with update status.
CompanyId String Id of the Company associated with the update.
Date Datetime Update created time .
CreatedBy String Id of the person who created update.
FirstPublishedAt Datetime Time when update is published.
LastModified Datetime Last time when changes for this update are made.
Visibility String Visibility of the update.
LifecycleState String State of the update.



CompanyUpdateStatistics

Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.

Select

The driver will use the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.

For example, the following queries are processed server side: 

SELECT * FROM CompanyUpdateStatistics WHERE CompanyId='183432'

SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId='urn:li:ugcPost:1234'

SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId IN ('urn:li:ugcPost:1234','urn:li:ugcPost:2345')
Columns

Name Type Description
Clicks Integer Total clicks count.
Comments Integer Total comments count.
CommentMentions Integer Total comment mentions count.
Engagement Double Total engagement count.
Impressions Integer Total impressions count.
Likes Integer Total likes count.
Shares Integer Total shares count.
ShareMentions Integer Total share mentions count.
UniqueImpressions Integer Total share mentions count.
TimeRangeStart Datetime Exclusive starting datetime of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime Inclusive ending datetime of when the query should end. Queries until current time when not set.
TimeGranularity String Granularity of the statistics. Must be either DAY or MONTH.
UGCPostId String The ID of the UGC post.
ShareId String The ID of the share.
CompanyId String Id of the Company associated with the update statistics.



OrganizationFollowerCount

The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.

Columns

Name Type Description
FirstDegreeSize Integer The number of first-degree connections (followers) for the organization.



Positions

Query the member's current positions.

Select

The Positions view retrieves all current positions for the logged in member. For example: 

SELECT * FROM Positions
Columns

Name Type Description
Id [KEY] String A unique identifier for the member's position.
Title String The title of the position.
Summary String A summary of the position.
StartMonth Integer The month when the position began.
StartYear Integer The year when the position began.
EndMonth Integer The month when the position ended.
EndYear Integer The year when the position ended.
IsCurrent Boolean A boolean value indicating whether the member is current in this position.
CompanyId String A unique identifier for the company.
CompanyName String The name of the company.



Profile

Lists the details of your profile.

Select

The Profile view supports only the Id column in the WHERE clause. The only supported operator for the Id column is =. For example: 

SELECT * FROM Profile

SELECT * FROM Profile WHERE Id='urn:li:person:e5eA-E_7Kb'
Columns

Name Type Description
Id [KEY] String The unique identifier for the person.
FirstName String The first name for the person.
LastName String The last name for the person.
Headline String The headline for the person. Often this is Job Title at Company.
Location String The Country code for the person.
Industry String The industry the LinkedIn member has indicated their profile belongs to.