Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Neo4j Version Support

The connector supports connections to both the Neo4j HTTP and Query APIs. For HTTP API connections, the connector supports self-managed instances of Neo4j version 4.2 and above. For Query API connections, the connector supports self-managed or cloud (Neo4J Aura) instances of version 5.19 or above.

Establish a Connection

Connect to Neo4j

HTTP API

To connect to Neo4j instances via the HTTP API, set the following connection properties:

API: Set this to 'HTTP'.
Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
Port: The port on which the Neo4j service is running. The provider connects to HTTP (7474) port by default. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server.
User: The username of the user using the Neo4j instance.
Password: The password of the user using the Neo4j instance.
Database: The database to target in the Neo4j instance. Defaults to "Neo4j".

Query API

To connect to Neo4j instances via the Query API, set the following connection properties:

API: Set this to 'Query'.
Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
Port: The port on which the Neo4j service is running. Self-managed instances have a default port of 7474 for the Query API. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server. If connecting to a Neo4J Aura instance, the port should always be 443.
User: The username of the user using the Neo4j instance.
Password: The password of the user using the Neo4j instance.
Database: The database to target in the Neo4j instance. Defaults to "Neo4j".

Neo4J Aura

To connect to Neo4j Aura instances, the required properties will be the same as the Query API configuration above. Notes on finding property values are below.

API: Set this to 'Query'.
Server: Found in 'Query API URL' in the 'Inspect' menu of the instance in the Neo4j Aura cloud console. Nothing after "Neo4j.io" should be provided.
Port: Set this to 443.
User: The username of the user using the Neo4j instance.
Password: Provided only once when creating the instance or when a new user is invited.
Database: Currently, Neo4j Aura deployments do not allow changing the database name from the default value of 'Neo4j'.

Important Notes

Configuration Files and Their Paths

All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Data Model

Overview

This section covers how the connector exposes your Neo4j graph database, and provides more information on executing SQL to Neo4j APIs.

Key Features

The connector models Neo4j graph node labels and relationships as relational views, allowing you to write SQL to query Neo4j data.
Stored procedures allow you to execute operations to Neo4j.
Live connectivity to these objects means any changes to your Neo4j account are immediately reflected when using the connector.

Modeling Node Graphs

Modeling Node Graphs details how node labels and relationships are exposed as views, as well as how properties are surfaced as columns.

Node and Relationship Filtering

The connector supports filtering which node labels and relationships are modeled as views. See Filtering Nodes and Relationships for more information.

Modeling Node Graphs

Each node in Neo4j has a set of unique labels, properties and can have any number of incoming and outgoing relationships (or none).

In order to present the contents of a node graph as a SQL database, the connector models node labels as tables and relationships as read-only views.

Node Labels

Node labels are Neo4j's primary method for categorizing nodes, so they have been adapted into SQL views. Each node label is exposed as an individual table.

For example, the following query displays all nodes that contain a "Product" label:

SELECT * FROM Product

Note that, because nodes can have multiple labels, certain nodes appear in several label tables.

Insert

Nodes can be inserted to using standard SQL syntax. For example, the following query adds a new node with a "Product" label:

Note

In Neo4j, INSERTing a null value for an attribute is equivalent to not setting it at all.

INSERT INTO Product (Name) VALUES ('Television')

Update

Nodes can be updated with arbitrary filters. For example, the following query sets a new price for nodes labelled "Product" with a given name:

UPDATE Product SET Price=179.99 WHERE Name='Television'

Note

In Neo4j, a null value implies the non-existence of an attribute: if all nodes with a given label have null for an attribute, the attribute does not exist. As such, certain UPDATEs could alter the data model by erasing an attribute entirely.

Delete

Nodes can be deleted with arbitrary filters. For example, the following query deletes all nodes labelled "Product" with a given name:

DELETE FROM Product WHERE Name='Television'

Note

Neo4j does not allow deleting nodes attached to any edge. A delete can be forced in this instance by setting the DetachDelete property to true. This will remove any attachments the node has, which may impact the records present in relationship views.

Relationships

The connector models each novel combination of the following as a view.

Source node label
Destination node label
Relationship type (name)

The view associated with that combination takes the form of SourceName_RelationshipType_DestinationName.

For example, if there is at least one node with the label "Product" which has the relationship "Part_Of" with a node with the label "Category", you can query this relationship as follows:

SELECT * FROM Product_Part__Of_Category

Since the source and destination labels of the relationship denote its direction, bidirectional relationships are modeled as two views: A_RelationshipType_B and B_RelationshipType_A, where A and B represent unique node labels.

Note that, because nodes can have multiple relationships, certain nodes appear in several relationship views.

Properties

Properties are modeled as columns.

Node Properties

In nodes label views, properties are inherited from the nodes containing the node label, keeping their original names.

Relationship Properties

In relationship views, properties are inherited from the all instances of the source node, the destination node, and the relationship itself.

The following columns are exposed:

A source_<PropertyName> column for each property in the instances of the source node.
A destination_<PropertyName> column for each property in the instances of the destination node.
A relationship_<PropertyName> column for each property in the instances of the relationship.

Filtering Nodes and Relationships

The connector facilitates customization of how node labels and relationships are modeled.

Filtering Node Labels

By default, all labels across all nodes are exposed as views.

To expose only a subset of the labels in your node graph as views, set the NodeFilter connection property to a valid Cypher node label matching expression.

All of the node labels of the matched nodes are modeled as views.

For example, setting NodeFilter to "Label1" causes the connector to match all nodes containing the "Label1" label and model all of the node labels in the matched nodes as views.

Filtering Relationships

You can also limit which relationships are modeled as views.

The connector supports filtering relationships with respect to their type (the name of the relationship), their source node label, and their destination node label.

Relationship Type

By default, every unique combination of a source node label, relationship type, and destination node label is modeled as a view with the name SourceNodeLabel_RelationshipType_DestinationNodeLabel.

To filter out unwanted relationships from being exposed as views, set the RelationshipTypeFilter to a valid Cypher relationship type matching expression.

For example, setting RelationshipTypeFilter to "RelationshipType1" causes the connector to only model relationships with "RelationshipType1" as their type name as views.

Source and Destination Node Labels

You can filter the relationships exposed as views using source and destination node labels.

Set the RelationshipSourceFilter and RelationshipDestinationFilter connection properties to match relationships where the source and/or destination node(s) contain certain node labels.

Only relationships whose source and destination nodes meet the criteria outlined in these connection properties are exposed as views.

For example, setting RelationshipSourceFilter to "Label1" and RelationshipDestinationFilter to "LabelA" means that a relationship must contain the "Label1" label in the source node and the "LabelA" label in the destination node before it is exposed as a view.

You can specify either one or both of these properties.

System Tables

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

Schema Tables

The following tables return database metadata for Neo4j:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
`CatalogName`	`String`	The database name.

sys_schemas

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.

sys_tables

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.

sys_tablecolumns

Describes the columns of the available tables and views.

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

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

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.
`ColumnType`	`String`	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

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.

sys_procedureparameters

Describes stored procedure parameters.

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

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'findDenseNodes' AND IncludeResultColumns='True'

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.
`DataType`	`Int32`	An integer indicating the data type. This value is determined at run time based on the environment.
`DataTypeName`	`String`	The name of the data type.
`NumericPrecision`	`Int32`	The maximum precision for numeric data. The column length in characters for character and date-time data.
`Length`	`Int32`	The number of characters allowed for character data. The number of digits allowed for numeric 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.
`Values`	`String`	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
`SupportsStreams`	`Boolean`	Whether the parameter represents a file that you can pass as either a file path or a stream.
`IsPath`	`Boolean`	Whether the parameter is a target path for a schema creation operation.
`Default`	`String`	The value used for this parameter when no value is specified.
`SpecificName`	`String`	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
`IsProvided`	`Boolean`	Whether the procedure is added/implemented by , as opposed to being a native Neo4j procedure.

Pseudo-Columns

Name	Type	Description
`IncludeResultColumns`	`Boolean`	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

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

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

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.

sys_foreignkeys

Describes the foreign keys.

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

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.

sys_primarykeys

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.

sys_indexes

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

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.

sys_connection_props

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

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.

sys_sqlinfo

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

Discovering the Data Source's SELECT Capabilities

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

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`
`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 Data Sync version needed to access this driver.	`Standard`, `Starter`, `Professional`, `Enterprise`
`DATASYNCCATEGORY`	The 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.

sys_identity

Returns information about attempted modifications.

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

SELECT * FROM sys_identity

Columns

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.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
`Product`	`String`	The name of the product.
`Version`	`String`	The version number of the product.
`Datasource`	`String`	The name of the datasource the product connects to.
`NodeId`	`String`	The unique identifier of the machine where the product is installed.
`HelpURL`	`String`	The URL to the product's help documentation.
`License`	`String`	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
`Location`	`String`	The file path location where the product's library is stored.
`Environment`	`String`	The version of the environment or rumtine the product is currently running under.
`DataSyncVersion`	`String`	The tier of Sync required to use this connector.
`DataSyncCategory`	`String`	The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

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

Authentication

Property	Description
`AuthScheme`	Specifies the type of authentication to use when connecting to Neo4j. The authentication method determines how the connection is established and how the user’s credentials are verified. This property allows you to choose from various authentication methods, depending on the service requirements and the type of instance being used.
`User`	Specifies the user ID of the authenticating Neo4j user account.
`Password`	Specifies the password of the authenticating user account.

Connection

Property	Description
`Server`	The server hosting the Neo4j instance. You may optionally prepend a protocol prefix to the server address or name you specify, like `https://127.0.0.1`.
`Port`	The port to use when connecting to the Neo4j server. By default, this is set to 7474, which is the default of the HTTP API. When connecting to a local query API, the default port will be the same (7474). For Neo4j Aura connections, this property should be set to 443.
`API`	The API to connect to in your Neo4j instance. Supports connections to 'Query' or 'HTTP' API.
`Database`	The default database queried for your Neo4j instance.

SSL

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

Schema

Property	Description
`Location`	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
`BrowsableSchemas`	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
`Tables`	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC.
`Views`	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property	Description
`DetachDelete`	A boolean value that controls whether the provider uses DETACH DELETE automatically when executing DELETE query.
`MaxRows`	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
`NodeFilter`	A Cypher node label matching expression. The provider exposes all node labels from the matched nodes as views.
`Other`	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
`Pagesize`	The maximum number of records per page the provider returns when requesting data from Neo4j.
`PseudoColumns`	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
`QueryPassthrough`	This option passes the query to the Neo4j server as is.
`RelationshipDestinationFilter`	The type(s) of labels that must be present on the destination nodes of single-hop relationships that the provider will expose as views.
`RelationshipSourceFilter`	The node labels that must be present on the source nodes of single-hop relationships, which the provider will expose as views.
`RelationshipTypeFilter`	The relationship type(s) of single-hop relationships that the driver will expose as views.
`RowScanDepth`	The maximum number of rows to scan to look for the columns available in a table.
`Timeout`	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
`UserDefinedViews`	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

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

Property	Description
`AuthScheme`	Specifies the type of authentication to use when connecting to Neo4j. The authentication method determines how the connection is established and how the user’s credentials are verified. This property allows you to choose from various authentication methods, depending on the service requirements and the type of instance being used.
`User`	Specifies the user ID of the authenticating Neo4j user account.
`Password`	Specifies the password of the authenticating user account.

AuthScheme

Specifies the type of authentication to use when connecting to Neo4j. The authentication method determines how the connection is established and how the user’s credentials are verified. This property allows you to choose from various authentication methods, depending on the service requirements and the type of instance being used.

Possible Values

Basic, None

Data Type

string

Default Value

Basic

Remarks

The AuthScheme property defines the method used to authenticate and authorize the user when connecting to Neo4j. Select the appropriate option based on the service and the type of authentication required.

Neo4j supports the following authentication schemes:

Basic: Set this to use traditional User/Password authentication. This method involves providing a username and password for authentication.
None: Set this to use no authentication. When this is set, no authentication header is supplied with requests.

User

Specifies the user ID of the authenticating Neo4j user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Password

Specifies the password of the authenticating user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Connection

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

Property	Description
`Server`	The server hosting the Neo4j instance. You may optionally prepend a protocol prefix to the server address or name you specify, like `https://127.0.0.1`.
`Port`	The port to use when connecting to the Neo4j server. By default, this is set to 7474, which is the default of the HTTP API. When connecting to a local query API, the default port will be the same (7474). For Neo4j Aura connections, this property should be set to 443.
`API`	The API to connect to in your Neo4j instance. Supports connections to 'Query' or 'HTTP' API.
`Database`	The default database queried for your Neo4j instance.

Remarks

By default, a "neo4j" database will have been created on your Neo4j instance unless otherwise specified when the instance was created.

SSL

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

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

SSLServerCert

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

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

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

Schema

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

Property	Description
`Location`	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
`BrowsableSchemas`	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
`Tables`	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC.
`Views`	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\Neo4j Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\Neo4j Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

Platform	%APPDATA%
`Windows`	The value of the APPDATA environment variable
`Mac`	~/Library/Application Support
`Linux`	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note

If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note

If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

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

Property	Description
`DetachDelete`	A boolean value that controls whether the provider uses DETACH DELETE automatically when executing DELETE query.
`MaxRows`	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
`NodeFilter`	A Cypher node label matching expression. The provider exposes all node labels from the matched nodes as views.
`Other`	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
`Pagesize`	The maximum number of records per page the provider returns when requesting data from Neo4j.
`PseudoColumns`	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
`QueryPassthrough`	This option passes the query to the Neo4j server as is.
`RelationshipDestinationFilter`	The type(s) of labels that must be present on the destination nodes of single-hop relationships that the provider will expose as views.
`RelationshipSourceFilter`	The node labels that must be present on the source nodes of single-hop relationships, which the provider will expose as views.
`RelationshipTypeFilter`	The relationship type(s) of single-hop relationships that the driver will expose as views.
`RowScanDepth`	The maximum number of rows to scan to look for the columns available in a table.
`Timeout`	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
`UserDefinedViews`	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note

It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

Property	Description
`DefaultColumnSize`	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
`ConvertDateTimeToGMT=True`	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
`RecordToFile=filename`	Records the underlying socket data transfer to the specified file.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
    "MyView": {
        "query": "SELECT * FROM ProductCategory WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.