Sendgrid Data Model

Connection String Options

  1. Auto Cache
  2. Cache Connection
  3. Cache Driver
  4. Cache Location
  5. Cache Metadata
  6. Cache Query Result
  7. Connect On Open
  8. Firewall Password
  9. Firewall Port
  10. Firewall Server
  11. Firewall Type
  12. Firewall User
  13. Location
  14. Logfile
  15. Max Log File Size
  16. Offline
  17. Other
  18. Password
  19. Pool Idle Timeout
  20. Pool Max Size
  21. Pool Wait Time
  22. Proxy Auth Scheme
  23. Proxy Auto Detect
  24. Proxy Exceptions
  25. Proxy Password
  26. Proxy Port
  27. Proxy Server
  28. Proxy SSL Type
  29. Proxy User
  30. Pseudo Columns
  31. Readonly
  32. RTK
  33. SSL Server Cert
  34. Support Enhanced SQL
  35. Tables
  36. Timeout
  37. Use Connection Pooling
  38. User
  39. Verbosity
  40. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. With CacheQueryResult set, the driver updates the cache when you execute a SELECT query and returns the live results from the SendGrid data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query SendGrid in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [MarketingCampaigns#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, 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

 

 

  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.

    When this property is set, the driver builds a temporary, in-memory dataset that caches the results of the queries you execute. Result sets for subsequent queries are extracted from this dataset, if possible.

    This property is useful in BI, analytics, and other tools that generate queries for you. In these tools, explicit cache queries with the #CACHE syntax may not be an option.

  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the SendGrid metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies 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 CacheProvider and CacheConnection. Below 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. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

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

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

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
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
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below 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
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below 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
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

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 based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

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 is shipped in the JDK. You can find the JAR, 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:sendgrid:CacheLocation='c:/Temp/cachedir';APIKey=abc123;
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:sendgrid:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';APIKey=abc123;
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:sendgrid:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';APIKey=abc123;
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

jdbc:sendgrid:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';APIKey=abc123;
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for SendGrid 2017 installation directory.
SQL Server

 

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

jdbc:sendgrid:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';APIKey=abc123;
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:sendgrid:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';APIKey=abc123;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:sendgrid:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';APIKey=abc123;

 

 

Cache Location

Data Type

string

Default Value

""

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 to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the SendGrid catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the SendGrid 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

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to SendGrid 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 SendGrid 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).

 

Firewall Password

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.

 

Firewall Port

Data Type

string

Default Value

""

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.

 

Firewall Server

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.

 

Firewall Type

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

 

 

Firewall User

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.

 

Location

Data Type

string

Default Value

""

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 Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to 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.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

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

 

Integration and Formatting

 

   
ConvertDateTimeToGMT Whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.
ClientCulture This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
Culture This setting can be used to specify culture settings that determine how the driver interprets certain data types that are passed into the driver. For example, setting Culture='de-DE' will output German formats even on an American machine.

 

 

Password

Data Type

string

Default Value

""

Remarks

 

The password of the currently authenticated user.

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

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.

 

Pool Wait Time

Data Type

string

Default Value

""

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.

 

Proxy Auth Scheme

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:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

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

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

 

Proxy Password

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.

 

Proxy Port

Data Type

string

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.

 

Proxy Server

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.

 

Proxy SSL Type

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:

 

   
AUTO Default 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.
ALWAYS The connection is always SSL enabled.
NEVER The connection is not SSL enabled.
TUNNEL The 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.

 

 

Proxy User

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 username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

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

 

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. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to SendGrid and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the SendGrid API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

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. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

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

 

Use Connection Pooling

Data Type

string

Default Value

"false"

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

User

Data Type

string

Default Value

""

Remarks

 

The username of the currently authenticated user.

 

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 described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the request and the response.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

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. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Tables

  1. CustomFields
  2. Lists
  3. MarketingCampaigns
  4. Recipients
  5. Schedules
  6. Segments
  7. UnsubscribeGroups

CustomFields

Create, delete, and query Custom Fields in SendGrid.

 

Table Specific Information

 

Custom fields are filters for a Recipient that are defined by the user.

Select

 

You can retrieve all the CustomFields or filter them by Id:

SELECT * FROM CustomFields
SELECT * FROM CustomFields WHERE Id = '1'

 

Use quotations to filter on Custom Fields regardless of type.

Insert

 

To insert on CustomFields specify the Name of the field and its Type. The Type can be text, date, or number.

INSERT INTO CustomFields(name, type) VALUES ('age', 'number') 
Update

 

This table does not support updating.

Delete

 

You can only delete from CustomFields by specifying an Id:

DELETE FROM CustomFields WHERE Id = '1'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String False

The Id of the custom field.

Name String False

The name of the custom field.

Type String False

The type of the custom field. Allowed values are number, text, or date.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Lists

Create, update, delete, and query the available Lists in SendGrid.

 

Table-Specific Information

 

 

Select

 

The Lists table can only filtered by its Id.

SELECT * FROM Lists WHERE Id = '123'
Insert

 

Only the Name for the List is required to insert into this table.

INSERT INTO Lists(Name) VALUES ('TestList')
Delete

 

You can only delete from Lists by specifying an Id.

DELETE FROM Lists WHERE Id = '123'
Update

 

You can only update from Lists by specifying an Id.

UPDATE Lists Set Name = 'New Name' WHERE Id = '123'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] Integer True

The Id of the list.

Name String False

The name of the list.

RecipientCount Integer True

The recipient count of the list.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

MarketingCampaigns

Create, update, delete, and query Marketing Campaigns in SendGrid.

 

Table-Specific Information

 

 

Select

 

This table only supports filtering by Id. The following are the only possible SELECT queries:

SELECT * FROM MarketingCampaigns
SELECT * FROM MarketingCampaigns WHERE Id = '1'
Insert

 

The following columns are required in an insert: Title, Subject, SenderId, ListIds, SegmentIds, Categories, SuppressionGroupId, HtmlContent, and PlainContent.

Note that a CustomUnsubscribeUrl can be used in place of a SuppressionGroupId. However, SendGrid highly recommends to use SuppressionGroupId.

Use the check points below to find the SenderId and SuppressionGroupId inputs:

  • To find the SenderId, navigate to Marketing -> MarketingCampaigns -> Senders. Create a new sender if you do not have one already. Then click the gear on the Action column and select Edit. The Id is displayed on the navigation bar after /senders/id.
  • To find the SuppressionGroupId, insert into the UnsubscribeGroups table; the created Id is the SuppressionGroupId.
 
INSERT INTO MarketingCampaigns(Title, Subject, SenderId, ListIds, Categories, SuppressionGroupId, HtmlContent, PlainContent) VALUES ('Test Campaign', 'March Newsletter', '123', '1,2', 'fruits, health', '12', '<b>Eat Healthy</b>', 'Eat healthy')
Update

 

You can only update MarketingCampaigns by specifying an Id.

UPDATE MarketingCampaigns SET PlainContent = 'Eat healthier' WHERE Id = '123'
Delete

 

You can only delete from MarketingCampaigns by specifying an Id.

DELETE FROM MarketingCampaigns WHERE Id = '123'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The Id of the marketing campaign.

Title String False

The title of the marketing campaign.

Subject String False

The subject of the marketing campaign.

SenderId Integer False

The sender Ids of the marketing campaign, separated by a comma.

ListIds String False

The list of list Ids of the marketing campaign, separated by a comma.

SegmentIds String False

The list of segment Ids of the marketing campaign, separated by a comma.

Categories String False

The categories of the marketing campaign.

SuppressionGroupId Integer False

The suppression group Id of the marketing campaign.

CustomUnsubscribeUrl String False

The custom unsubscribe URL of the marketing campaign.

IpPool String False

The IP pool of the marketing campaign.

HtmlContent String False

The HTML content of the marketing campaign.

PlainContent String False

The content of the marketing campaign.

Status String True

The status of the marketing campaign.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Recipients

The SendGrid table Recipients.

 

Table Specific Information

 

SendGrid has the ability to categorize Recipients with filters defined by the user. Accordingly, you can execute statements to the Recipients table to search by and insert these filters. However, these filters are reported as attributes of the Custom Fields table.

Select

 

The following query retrieves only the default fields of the Recipients table, not the Custom Fields that you have created. To retrieve the values of the Custom Fields of a Recipient, query the Custom Fields table.

SELECT * FROM Recipients

 

You can also retrieve all Recipients inside a certain List or a Segment, but it is not possible to filter by both. Use multiple queries instead:

SELECT * FROM Recipients WHERE SegmentId = '1'
SELECT * FROM Recipients WHERE ListId = '2'

 

You can build criteria depending on a Custom Field. When querying use quotations regardless of type. In this case Age is a CustomField created by the user.

SELECT * FROM Recipients WHERE Age = '30'
Insert

 

You can insert Custom Fields into the Recipients table. See the CustomFields section for more information about how to create custom fields.

INSERT INTO Recipients(Email, FirstName, LastName, Age, Department ... Other Custom Fields as necessary) VALUES('email@domain.com', 'name' ,'surname', '30', 'Education' ... Other Custom Field values)
Update

 

You can only update from this table by specifying an Id. Additionally, the Email column cannot be updated.

UPDATE Recipients SET Age = '12' WHERE Id = '1'
Delete

 

You can only delete from this table by specifying an Id.

DELETE FROM Recipients WHERE Id = '1'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String False

This column is dynamic and maps to the corresponding field in the API.

SegmentId Int32 False

This column is dynamic and maps to the corresponding field in the API.

ListId Int32 False

This column is dynamic and maps to the corresponding field in the API.

Email String False

This column is dynamic and maps to the corresponding field in the API.

FirstName String False

This column is dynamic and maps to the corresponding field in the API.

LastName String False

This column is dynamic and maps to the corresponding field in the API.

CreatedAt Datetime False

This column is dynamic and maps to the corresponding field in the API.

LastClicked Datetime False

This column is dynamic and maps to the corresponding field in the API.

LastEmailed Datetime False

This column is dynamic and maps to the corresponding field in the API.

LastOpened Datetime False

This column is dynamic and maps to the corresponding field in the API.

UpdatedAt Datetime False

This column is dynamic and maps to the corresponding field in the API.

Age String False

This column is dynamic and maps to the corresponding field in the API.

Department String False

This column is dynamic and maps to the corresponding field in the API.

University String False

This column is dynamic and maps to the corresponding field in the API.

 

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
rows@next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Schedules

Create, update, delete, and query Campaign Schedules in SendGrid.

 

Table-Specific Information

 

 

Select

 

You can only retrieve Schedules by providing a MarketingCampaignId.

SELECT * FROM Schedules WHERE MarketingCampaignId = '123'
Insert

 

Provide MarketingCampaignId and SendAt to schedule a campaign at a specific time. You can set SendAt to now to immediately send a campaign.

INSERT INTO Schedules(MarketingCampaignId, SendAt) VALUES (1, 'now')
Update

 

You can only update Schedules by specifying a MarketingCampaignId.

UPDATE Schedules SET SendAt = '01-01-2016' WHERE MarketingCampaignId = '123'
Delete

 

You can only delete Schedules by specifying a MarketingCampaignId.

DELETE FROM Schedules WHERE MarketingCampaignId = '123'
Columns

 

 

 

   
Name Type ReadOnly Description
MarketingCampaignId [KEY] Integer True

Id of the campaign.

Status String True

Status of the campaign.

SendAt Datetime False

Date to start the campaign.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Segments

Create, update, delete, and query Segments in SendGrid.

 

Table-Specific Information

 

 

Select

 

You can retrieve all the segments or filter them by Id.

SELECT * FROM Segments
SELECT * FROM Segments WHERE Id = '1'
Insert

 

A Segment divides Recipients by certain criteria. To specify these criteria use the ConditionsField columns and the Id of the List to apply these criteria to.

The ConditionsAndOr columns connect the given Field with the previous one.

INSERT INTO Segments(Name, ListId, ConditionsField1, ConditionsValue1, ConditionsOperator1, ConditionsAndOr1, ConditionsField2, ConditionsValue2, ConditionsOperator2, ConditionsAndOr2) VALUES ("New Segment", 123, 'age', '20', '>', '', 'age', '30', '<', 'and')

 

The statement above creates Segments containing Recipients between age 20 and 30.

Update

 

You can update the name or the conditions. Since the whole set will be overwritten, specify a full set.

UPDATE Segments Set Name='Name Updated', ConditionsField1 = 'age', ConditionsOperator1 = '<=', ConditionsAndOr1 = '', ConditionsValue1 = '30' WHERE Id = '123'
Delete

 

You can only delete Segments by Id:

DELETE FROM Segments WHERE Id = '123'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] Integer True

The Id of the segment.

Name String False

The name of the segment.

ListId Integer False

The Id of the list associated with the segment.

RecipientCount Integer True

The recipient count of the segment.

ConditionsField1 String False

Field name for the first condition.

ConditionsValue1 String False

Field value for the first condition.

ConditionsOperator1 String False

Condition operator for the first condition.

ConditionsAndOr1 String False

How to connect to the previous condition. Allowed values are AND or OR.

ConditionsField2 String False

Field name for the second condition.

ConditionsValue2 String False

Field value for the second condition.

ConditionsOperator2 String False

Condition operator for the second condition.

ConditionsAndOr2 String False

How to connect to the previous condition. Allowed values are AND or OR.

ConditionsField3 String False

Field name for the third condition.

ConditionsValue3 String False

Field value for the third condition.

ConditionsOperator3 String False

Condition operator for the third condition.

ConditionsAndOr3 String False

How to connect to the previous condition. Allowed values are AND or OR.

ConditionsField4 String False

Field name for the fourth condition.

ConditionsValue4 String False

Field value for the fourth condition.

ConditionsOperator4 String False

Condition operator for the fourth condition.

ConditionsAndOr4 String False

How to connect to the previous condition. Allowed values are AND or OR.

ConditionsField5 String False

Field name for the fifth condition.

ConditionsValue5 String False

Field value for the fifth condition.

ConditionsOperator5 String False

Condition operator for the fifth condition.

ConditionsAndOr5 String False

How to connect to the previous condition. Allowed values are AND or OR.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

UnsubscribeGroups

Create, update, delete, and query Unsubscribe Groups in SendGrid.

 

Table-Specific Information

 

 

Select

 

UnsubscribeGroups can only be filtered by Id.

SELECT * FROM UnsubscribeGroups WHERE Id = '1'
Insert

 

Provide a Name and a Description to insert into UnsubscribeGroups:

INSERT INTO UnsubscribeGroups(Name, Description, IsDefault) VALUES ('Unsubscribe1', 'General Unsubscribe', true)
Update

 

You can only update UnsubscribeGroups by specifying an Id.

Update UnsubscribeGroups SET Name = 'New Name', Description = 'New Description' WHERE Id = '1'
Delete

 

You can only delete from UnsubscribeGroups by specifying an Id.

DELETE FROM UnsubscribeGroups Where Id = '1'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] Integer True

Id of the unsubscribe group.

Name String False

The name of the unsubscribe group.

Description String False

The description of the unsubscribe group.

LastEmailSentAt Datetime True

The last time an email was sent to the unsubscribe group.

IsDefault Boolean False

If the unsubscribe group is the default group or not.

Unsubscribes Integer True

The number of unsubscribes from this group.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 




 

Views

  1. AdvancedStats
  2. Bounces
  3. CategoryStats
  4. GlobalStats
  5. ReservedFields
  6. SubuserStats
  7. Users

AdvancedStats

Query Advanced Statistics in SendGrid.

 

View-Specific Information
Select

 

By default, the Type of the statistics retrieved is Geo. Additionally, you need to specify a time span to select from this table. If you do not specify one, a default span of the last week is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM AdvancedStats WHERE Date > '2016-01-01' AND Date < '2016-01-30'
Columns

 

 

 

   
Name Type Description
Type String The type of the statistic.
Name String The name of the statistic.
Date Date The time the global statistic was created.
Blocks Integer The number of emails that were not allowed to be delivered by ISPs.
Drops Integer The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces Integer The number of emails that bounced instead of being delivered.
Clicks Integer The number of links clicked in your emails.
Deferred Integer The number of emails temporarily refused by the receiving server.
Delivered Integer The number of emails confirmed delivered.
InvalidEmails Integer The number of emails with a malformed address or reported as invalid by the receiving server.
Opens Integer The number of times your emails were opened by recipients.
Processed Integer The number of emails pushed to SendGrid.
Requests Integer The number of emails you requested to send via SendGrid.
SpamReportDrops Integer The number of emails automatically dropped because the emails were marked as spam by the recipient.
SpamReports Integer The number of emails marked as spam by recipients.
UniqueClicks Integer The number of unique recipients who clicked links in your emails.
UniqueOpens Integer The number of unique recipients who opened your emails.
UnsubscribeDrops Integer The number of emails in this category dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes Integer The number of recipients who unsubscribed from your emails.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Bounces

Query the available Bounces in SendGrid.

 

View-Specific Information
Select

 

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 120 days is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM Bounces WHERE Date > '2016-01-01' AND Date < '2016-01-30'
Columns

 

 

 

   
Name Type Description
CreatedAt Datetime The time the bounce was created.
Reason String The reason for the bounce.
Email String The email that bounced.
Status String The enhanced SMTP bounce response.
Date Datetime The end of the time range when the bounce was created.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

CategoryStats

Query the available Category Stats in SendGrid.

 

Table-Specific Information
Select

 

To query CategoryStats provide the Name of the category you want the statistics for.

 
SELECT * FROM CategoryStats WHERE Name = 'news'

 

You can also filter by Date. If you do not specify a date range, a default span of the last week is used. The operators =, >=, <=, <, and > are supported for this column.

SELECT * FROM CategoryStats WHERE Name = 'news' AND Date > '2016-01-01' AND Date < '2016-01-30'
Columns

 

 

 

   
Name Type Description
Type String The type of the statistic.
Name String The name of the category.
Date Date The time the global statistic was created.
Blocks Integer The number of emails that were not allowed to be delivered by ISPs.
Drops Integer The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces Integer The number of emails that bounced instead of being delivered.
Clicks Integer The number of links clicked in your emails.
Deferred Integer The number of emails temporarily refused by the receiving server.
Delivered Integer The number of emails confirmed delivered.
InvalidEmails Integer The number of emails with a malformed address or reported as invalid by the receiving server.
Opens Integer The number of times your emails were opened by recipients.
Processed Integer The number of emails pushed to SendGrid.
Requests Integer The number of emails you requested to send via SendGrid.
SpamReportDrops Integer The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports Integer The number of emails marked as spam by recipients.
UniqueClicks Integer The number of unique recipients who clicked links in your emails.
UniqueOpens Integer The number of unique recipients who opened your emails.
UnsubscribeDrops Integer The number of emails in this category dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes Integer The number of recipients who unsubscribed from your emails.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

GlobalStats

Query the available Global Stats in SendGrid.

 

View-Specific Information
Select

 

You need to specify a time span to select from this table. If you do not specify one, a default span of the last week is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM GlobalStats WHERE Date > '2016-01-01' AND Date < '2016-01-30'
Columns

 

 

 

   
Name Type Description
Date Date The time the global statistic was created.
Blocks Integer The number of emails that were not allowed to be delivered by ISPs.
BounceDrops Integer The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces Integer The number of emails that bounced instead of being delivered.
Clicks Integer The number of links clicked in your emails.
Deferred Integer The number of emails temporarily refused by the receiving server.
Delivered Integer The number of emails confirmed delivered.
InvalidEmails Integer The number of emails with a malformed address or reported as invalid by the receiving server.
Opens Integer The number of times your emails were opened by recipients.
Processed Integer The number of emails pushed to SendGrid.
Requests Integer The number of emails you requested to send via SendGrid.
SpamReportDrops Integer The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports Integer The number of emails marked as spam by recipients.
UniqueClicks Integer The number of unique recipients who clicked links in your emails.
UniqueOpens Integer The number of unique recipients who opened your emails.
UnsubscribeDrops Integer The number of emails globally dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes Integer The number of recipients who unsubscribed from your emails.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

ReservedFields

Query the available Reserved Fields in SendGrid.

 

View-Specific Information

 

 

Select

 

This table does not support filtering.

SELECT * FROM ReservedFields
Columns

 

 

 

   
Name Type Description
Name String The name of the reserved field.
Type String The type of the reserved 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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

SubuserStats

Query Subuser Statistics in SendGrid.

 

View-Specific Information
Select

 

You need to specify a SubuserName to retrieve the stats of.

SELECT * FROM SubuserStats WHERE SubuserName = 'a'

 

You can also filter by Date. Operators =, >=, <=, <, and > are supported for this column. If you do not specify a date range, a default span of the last week is used.

SELECT * FROM SubuserStats WHERE SubuserName = 'news' AND Date > '2016-01-01' AND Date < '2016-01-30'
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the subuser statistic.
SubuserName String The name of the subuser.
Date Datetime The time the subuser statistic was created.
Blocks Integer The number of emails that were not allowed to be delivered by ISPs.
Drops Integer The number of emails automatically dropped because they appear on one of the suppression lists.
Bounces Integer The number of emails that bounced instead of being delivered.
Clicks Integer The number of links that were clicked in the emails from this subuser.
Deferred Integer The number of emails temporarily refused by the receiving server.
Delivered Integer The number of emails from this subsuer that were confirmed delivered.
InvalidEmails Integer The number of emails with a malformed address or reported as invalid by the receiving server.
Opens Integer The number of times emails from this subuser were opened by recipients.
Processed Integer The number of emails pushed to SendGrid by this subuser.
Requests Integer The number of emails that you requested to send via SendGrid from this subuser.
SpamReportDrops Integer The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports Integer The number of emails from this subuser that were marked as spam by recipients.
UniqueClicks Integer The number of unique recipients who clicked on links in your emails from this subuser.
UniqueOpens Integer The number of unique recipients who opened your emails from this subuser.
UnsubscribeDrops Integer The number of emails from this subuser dropped by SendGrid because the recipients unsubscribed from your emails.
Unsubscribes Integer The number of recipients who unsubscribed from your emails from this subuser.
Name String The name of the statistic.
Type String The type of the statistic.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Users

Query the available Users in SendGrid.

 

View-Specific Information

 

 

Select

 

Users can only be filtered by Id.

SELECT * FROM Users WHERE Id = '1'
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the user.
Address String The address of the user.
Address2 String The secondary address field for the user.
City String The city of the user.
Company String The company of the user.
Country String The country of the user.
FirstName String The first name of the user.
LastName String The last name of the user.
Phone String The phone number of the user.
State String The state the user is located in.
Website String The Web site URL of the user.
Zip String The ZIP code of the user.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.