This page provides a guide to Establishing a Connection to Sansan in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Sansan

Establishing a Connection shows how to authenticate to Sansan and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Sansan through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Sansan by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Sansan

When using the CData Cloud to connect to Sansan, APIKey is required.

Configure Access to Sansan

To obtain the APIKey, follow the steps below:

• Log in to the Sansan management page [https://ap.sansan.com/v/home/] and go to "3rd Party Integration" -> "API".
• Select the target department from the "Please select department" pull-down list.
• Select the target user from the "Please select user" pull-down list.
• Click the "Issue" button to generate the API key.

Authenticate to Sansan Account

Set the following connection property to connect:

• APIKey: Set the API Key. This is the key obtained from your Sansan management screen.

Customizing the SSL Configuration

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

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

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models Sansan objects as relational tables and views. A Sansan object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Sansan APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

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

CData Cloud - Sansan Tables

Name	Description
Bizcards	Create and query all the Bizcards that the user has scanned or those that the organization has

Create and query all the Bizcards that the user has scanned or those that the organization has

Table Specific Information

Select

The Cloud will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM Bizcards WHERE UpdatedTime > '2018-03-14'

SELECT * FROM Bizcards WHERE UpdatedTime = '2018-03-14 18:35:06.0'

SELECT * FROM Bizcards WHERE UpdatedTime > '2018-03-14' AND UpdatedTime < '2019-03-14'

SELECT * FROM Bizcards WHERE Email = '[email protected]'

SELECT * FROM Bizcards ORDER BY UpdatedTime Desc

SELECT * FROM Bizcards ORDER BY RegisteredTime

SELECT * FROM Bizcards WHERE CONTAINS(CompanyName, 'kei') AND CONTAINS(Tel, '7390') AND CONTAINS(Mobile, '7415')

SELECT * FROM Bizcards WHERE SearchTerm = 'kei'

We can override the Range connection property by specifing it inside the query for ex.:

SELECT * FROM Bizcards WHERE Range = 'me'

Insert

INSERT INTO Bizcards ('OwnerId', 'FirstName', 'LastName', 'SharingPermissionsEmail') VALUES ('afd425d', 'John', 'Doe', true)

Columns

Name	Type	ReadOnly	Description
BizcardId [KEY]	String	True	The Id of the Bizcard
CompanyId	String	True	The Id of the Company
PersonId	String	True	The Id of the person
ExchangeDate	Date	False	The date when Bizcards were exchanged
RegisteredTime	Datetime	True	The datetime when the Bizcard was registered
UpdatedTime	Datetime	True	The datetime when the Bizcard was last updated
OwnerId	String	False	The Id of the owner
OwnerName	String	True	The name of the owner
OwnerEmail	String	True	The email of the owner
LastName	String	False	The last name found on Bizcard
FirstName	String	False	The first name found on Bizcard
LastNameReading	String	False
FirstNameReading	String	False
DepartmentName	String	False	The name of the department found on Bizcard
Title	String	False	The title found on Bizcard
Email	String	False	The email found on Bizcard
Mobile	String	False	The mobile number found on Bizcard
CompanyName	String	False	The company name found on Bizcard
CountryCode	String	False	The country code found on Bizcard
PostalCode	String	False	The postal code found on Bizcard
Address	String	True	The address found on Bizcard
Prefecture	String	False	The prefecture found on Bizcard
City	String	False	The city found on Bizcard
Street	String	False	The street found on Bizcard
Building	String	False	The building found on Bizcard
Tel	String	False	The telephone number found on Bizcard
SecondTel	String	False	The second telephone number found on Bizcard
Fax	String	False	The fax number found on Bizcard
Url	String	False	The url found on Bizcard
Memo	String	False	The memo found on Bizcard
EntryStatus	String	True	The status of the Bizcard {processing, completed, unreadable}
IsUserCreated	Boolean	True	Determines if the bizcard has been created by the user or not
HasUnrecognizedChar	Boolean	True	Determines if the bizcard has unrecognized char or not
TagId	String	False	The tag ID to be linked to the business card. This column is supported for Insert only.
SharingPermissionsCompanyInformation	Boolean	False	Company information public/private setting. This column is supported for Insert only.
SharingPermissionsName	Boolean	False	Name public/private setting. This column is supported for Insert only.
SharingPermissionsExchangeDate	Boolean	False	Exchange date public/private setting. This column is supported for Insert only.
SharingPermissionsContact	Boolean	False	Contact public/private setting. This column is supported for Insert only.
SharingPermissionsMobile	Boolean	False	Mobile public/private setting. This column is supported for Insert only.
SharingPermissionsEmail	Boolean	False	Email public/private setting. This column is supported for Insert only.
SharingPermissionsMemo	Boolean	False	Memo public/private setting. This column is supported for Insert only.
SharingPermissionsOthers	Boolean	False	Others public/private setting. This column is supported for Insert only.

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
Range	String	Used to override the range connection property
SearchTerm	String	Search FirstName or LastName starting by criteria

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

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

CData Cloud - Sansan Views

Name	Description
AcquireDepartment	This will acquire departments registered in Sansan
AcquireUser	This will acquire users registered in Sansan
BizcardTags	Join Table for Tags and Bizcards
Contacts	Get a Set of contacts. The contacts are ordered by update time.
ExternalAttendees	Usage information for the operation ExternalAttendees.rsd.
InternalAttendees	Usage information for the operation InternalAttendees.rsd.
Tags	Returns all tags created by user or organization tags

This will acquire departments registered in Sansan

Columns

Name	Type	Description
TempId	String	This is the temporary identifier used when adding departments
DepartmentId	String	This is the department identifier
DepartmentName	String	This is the departments name
DepartmentNamePhonetic	String	If the departments name is not written alphabetically, you can enter the phonetic alphabetic reading of the name here
ParentDepartmentId	String	This is the identifier for a parent department
Order	Integer	This is the display order of the department
DeleteFlag	Integer	This is the flag used to delete departments

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
Delimiter	String	Separator in the CSV format response

This will acquire users registered in Sansan

Columns

Name	Type	Description
TempId	String	This is the temporary identifier used when adding users
UserUuid	String	This is the identifier to uniquely identify a user in Sansan
DepartmentId	String	This is the identifier for the department that the user belongs to
UserId	String	This is the identifier for display that uniquely identifies a user in Sansan
UserName	String	This is the users name
AlternativeName	String	This can use be used for alternative names or foreign language names
Email	String	This is the users email address
SubEmail	String	This is the users sub-email address
EffectiveDateFrom	String	This is the date when Sansan usage started
Culture	Integer	This is the display language when using Sansan
MailFormat	Integer	This is the format for receiving emails
SamlNameId	String	This is the identifier for SAML authentication
UserType	Integer	This is the user type
CanUpdateData	Integer	This is the permission to update all data
DataDownloadPrivilege	Integer	This is the permission to download business cards and reports
EmailDeliveryPrivilege	Integer	This is the permission to use email delivery
SalesforceIntegrationPrivilege	Integer	This is the permission to link business card data with Salesforce
DealPrivilege	Integer	This is the permission to use Deal management
ApiIntegrationPrivilege	Integer	This is the permission to use API linking
UsageStatisticsPrivilege	Integer	This is the permission to check actual usage of Sansan
OrganizationTreeDownloadPrivilege	Integer	Input 1 to give this permission
DeleteFlag	Integer	This is the flag used to delete users

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
Delimiter	String	Separator in the CSV format response

Join Table for Tags and Bizcards

Table Specific Information

Select

The Cloud will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM BizcardTags

We can override the Range connection property by specifing it inside the query for ex.:

SELECT * FROM BizcardTags WHERE Range = 'me'

Columns

Name	Type	Description
BizcardId [KEY]	String	The Id of the Bizcard
TagID [KEY]	String	The Id of the Tag

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
Range	String	Used to override the range connection property

Get a Set of contacts. The contacts are ordered by update time.

Table Specific Information

Select

The Cloud will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM Contacts WHERE UpdatedTime > '2018-03-14'

SELECT * FROM Contacts WHERE UpdatedTime = '2018-03-14 18:35:06.0'

SELECT * FROM Contacts WHERE UpdatedTime > '2018-03-14' AND UpdatedTime < '2019-03-14'

SELECT * FROM Contacts WHERE Type = 'Meeting'

SELECT * FROM Contacts WHERE Categories = 'category'

SELECT * FROM Contacts ORDER BY UpdatedTime Desc

SELECT * FROM Contacts ORDER BY RegisteredTime

We can override the Range connection property by specifing it inside the query for ex.:

SELECT * FROM Contacts WHERE Range = 'me'

Columns

Name	Type	Description
Id [KEY]	String	The identifier of teh contact.
RegisteredTime	Datetime	The datetime when the contact has been created.
UpdatedTime	Datetime	The datetime when the contact has been modified for the last time.
StartDate	Date
StartTime	Datetime
EndDate	Date
EndTime	Datetime
OwnerId	String	The identifier of the owner.
OwnerName	String	The name of the owner.
OwnerEmail	String	The email of the owner.
Type	String	The type of the contact.
Categories	String	The contact categories.
Title	String	The title of the contact.
Location	String	The location of the contact.
Memo	String	The memo of the contact.
ExternalAttendees	String	The external attendees associated with the contact.
InternalAttendees	String	The internal attendees associated with the contact.

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
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Usage information for the operation ExternalAttendees.rsd.

Table Specific Information

Select

Everything will be executed client side within the driver.

Columns

Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
PersonId	String	The person identifier associated with the attendee.
CompanyName	String	The company where the attendee belongs to.
LastName	String	The last name of the attendee.
FirstName	String	The first name of the attendee.

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
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Usage information for the operation InternalAttendees.rsd.

Table Specific Information

Select

Everything will be executed client side within the driver.

Columns

Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
Name	String	The name of the attendee.
DepartmentName	String	The department where the attendee belongs to.

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
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Returns all tags created by user or organization tags

Table Specific Information

Select

The Cloud will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM Tags

We can override the Range connection property by specifying it inside the query for ex:

SELECT * FROM Tags WHERE Range = 'me'

We can also get all Tags of a Bizcard by specifying the BizcardId in the query for ex:

SELECT * FROM Tags WHERE BizcardId = '00E683BEE2DFC04399B3CC8DA5591A24'

Columns

Name	Type	Description
TagID [KEY]	String	The Id of the Tag
Name	String	The name of the Tag
Type	String	The type of the Tag {public, shared, private}
OwnerID	String	The Id of the owner
OwnerName	String	The name of teh owner
OwnerEmail	String	The email of the owner

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
Range	String	Used to override the range connection property
BizcardId	String	Used to get the tags of a Bizcard specified by BizcardId

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT operations with Sansan.

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

CData Cloud - Sansan Stored Procedures

Name	Description

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

Schema Tables

The following tables return database metadata for Sansan:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

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

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

Describes the columns of the available tables and views.

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

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

Columns

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

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Describes stored procedure parameters.

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

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

Columns

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

Describes the primary and foreign keys.

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

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

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

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

jdbc:cdata:sansan:config:

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns

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

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

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

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
APIKey	The Sansan API key.
IncludePastBizcards	IncludePastBizcards.
Range	The Sansan Range of holders for acquisition.

SSL

---

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

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from Sansan.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
APIKey	The Sansan API key.
IncludePastBizcards	IncludePastBizcards.
Range	The Sansan Range of holders for acquisition.

The Sansan API key.

Data Type

string

Default Value

""

Remarks

Used for authentication. You can get an APIKey by going to the settings page of your account.

IncludePastBizcards.

Data Type

bool

Default Value

false

Remarks

Determines if older versions of each bizcard should be included

The Sansan Range of holders for acquisition.

Data Type

string

Default Value

"all"

Remarks

The Range connection property determines the scope of the data fetched from the API. If Range is set to "all" the provider will fetch all Bizcards or Tags of the organization in which the user is part of. Otherwise if Range is set to "me" it will fetch my Bizcards or Tags. You can override this connection property while querying for ex.:

SELECT * FROM Bizcards WHERE Range='all'

SELECT * FROM Tags WHERE Range='me'

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

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

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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

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

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

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

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

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

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

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

Data Type

string

Default Value

""

Remarks

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

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from Sansan.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

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

Data Type

int

Default Value

-1

Remarks

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

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

Data Type

int

Default Value

300

Remarks

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

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

Data Type

string

Default Value

""

Remarks

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

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

Data Type

int

Default Value

60

Remarks

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

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