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

Connecting to Odoo

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

Accessing Data from CData Cloud Services

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

Connect to Odoo 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 Odoo

To connect, set the Url to a valid Odoo site, User and APIToken to the connection details of the user you are connecting with, and Database to the Odoo database.

If you are not using API tokens (they are only supported in Odoo 14 and above), you can also provide the password in the APIToken field.

Access Rights

In order for the Cloud to determine what models you can access in Odoo, the user you connect with must have permissions to read from "ir.model.access" (an internal Odoo model that governs access rights). Normally this is reserved for administrators, but it can be granted to any user by creating a service group:

1. As an administrator, open the Odoo settings page and enable "developer mode". If this is not available you may need to login as the superuser instead.
2. Open the Groups page (under the Users dropdown) and create a new group
3. Set the Application to "Administration" and the name to "Service Access"
4. Add any users who need service access in the Users tab
5. In the Access Rights tab, add an entry for the "ir.model.access" object (it may be called "Model Access"), check Read Access, and give it the name "Inspect Models"
6. Save the group

If making this change is not possible, then you should set the CheckPermissions option to false. That will list all models in Odoo as tables, regardless of what permissions your user actually has for those models.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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 Cloud represents Odoo models as relational tables and views. The table definitions are dynamically obtained from the Odoo site you connect to, and the exact ones that will be availble to you will be different depending upon the apps you have installed. The tables listed here are only examples, which may differ from the ones available to you.

Tables

When connecting, the Cloud determines what models you can modify and which are read-only. Models that can be modified are represented as tables, which have support for reading, inserting, updating and deleting data.

Views

Any models that are read-only are represented as views. You can read data from them the same as you would a table, but inserting, updating and deleting are not allowed.

Many2One, One2Many and Many2Many Columns

Within Odoo, in addition to columns with simple values like text and dates, there are also columns that contain multiple values on each row. The Cloud decodes these kinds of values differently, depending upon the type of column the value comes from:

Many2One

Many2One columns are references to a single row within another model. Within the Cloud, Many2One columns are represented as integers, whose value is the id that they refer to in the other model.

For example, the Calendar module inludes a model for events called "calendar_event", which has a column called "opportunity_id" that refers to an opportunity in the "crm_lead" model. When creating or updating a calendar event, you can set the opportunity_id to the id of the lead the meeting is for:

INSERT INTO calendar_event (name, start, stop, opportunity_id) VALUES ('Meet With Potential Customer', '...', '...', 42)

If you were to read this event later, the value of opportunity_id would be the number 42.

Many2Many

Many2Many columns are references to many rows within another model. Within the Cloud, Many2Many columns are represented as text containing a comma-separated list of integers. Each value in that list is the id of a row that is being referenced.

For example, the Calendar module inludes a model for events called "calendar_event", which has a column called "partner_ids" that refers to contacts in the "res_partner" model. When creating or updating a calendar event, you can set the partner_ids to the ids of the people who are attending the meeting:

INSERT INTO calendar_event (name, start, stop, partner_ids) VALUES ('Meet With Potential Customer', '...', '...', '13,57')

If you were to read this event later, the value of partner_ids would be the text "13,57" (or "57,13", since the ids can be in any order).

One2Many

One2Many columns are references to many rows within another model - they are similar to Many2Many columns, except that each row in the referenced model must belong to only one in the main model.

For example, the Calendar module inludes a model for events called "calendar_event", which has a column called "attendee_ids" that refers to the meeting invitations stored in the "event_attendee" model. Unlike partner_ids, where different meetings can share the same partners and different partners can go to the same meeting, each invitation is linked to just one event.

Currently, these columns are read the same was as Many2Many columns (as text containing a comma-separated list of ids), but they cannot be written to.

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 - Odoo Views

Name	Description
FieldReferences	Retrieves both single-value and multi-value references from a table.

Retrieves both single-value and multi-value references from a table.

Columns

Name	Type	References	Description
ReferenceTable	String		The name of the table containing the reference field.
ReferenceColumn	String		The name of column that refers to another field.
TargetTable	String		The name of the table targetted by the reference.
IsMultiValued	Boolean		Whether the reference column contains multiple values.

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

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

CData Cloud - Odoo Stored Procedures

Name	Description
CallProcedure	Calls a server-side RPC within Odoo.

Calls a server-side RPC within Odoo.

Procedure-Specific Information

Odoo exposes its RPCs using the External API. This API uses an XML-RPC method called execute_kw to call Odoo procedures on specific modules. Internally the method looks like this:

execute_kw(database, user_id, password, model, operation, arguments, keyword_args)

The Cloud will provide the connection information automatically, so the only parameters required for CallProcedure are the model, the operation, a list of arguments and a map of keyword arguments. The arguments and keyword arguments are provided as a JSON array and object respectively. The Cloud will take the result of the RPC and convert it back into JSON for the procedure output.

For example, you could call the 'read' method on the 'hr.employee' model to read information about specific employees. In this case you would retrieve the name and department for the employees with the IDs 2 and 4:

EXECUTE CallProcedure
  Model = 'hr.employee',
  Operation = 'read',
  -- The read RPC takes one argument, which is the list of IDs
  Arguments = '[[4, 2]]',
  KeywordArgs = '{"fields": ["department_id", "name"]}'

Calling this procedure on the Odoo sample data will return this JSON result:

[
  {"department_id": [4, "Research & Development"], "id": 4, "name": "Sharlene Rhodes"},
  {"department_id": [4, "Research & Development"], "id": 2, "name": "Ronnie Hart"}
]

Input

Name	Type	Description
Model	String	The model to execute the procedure on.
Operation	String	The procedure to execute.
Arguments	String	The list of arguments to pass to the RPC, formatted as a JSON list
KeywordArgs	String	The keyword arguments to pass to the RPC, formatted as a JSON object

Result Set Columns

Name	Type	Description
JSON	String	The output of the RPC converted to JSON.

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 Odoo:

• 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 res_users table:

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

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 CallProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CallProcedure' 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 res_users table:

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

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.

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.

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 CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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
URL	The base URL of the Odoo site you're connecting to. For example, http://my.odoo.com/.
Database	The name of the Odoo database you're connecting to.
OdooEdition	The edition of Odoo being used. Set either Odoo Online or Odoo On-Premise.
User	The Odoo user account used to authenticate.
APIToken	The API token (or password) used to authenticate the user.
CheckPermissions	Whether to use Odoo user's permissions to determine which tables and views to list.

SSL

---

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

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
AllowComputedFields	Boolean determining whether computed names from Odoo are mapped to columns.
ExpandReferences	Boolean determining if multi-valued Many2Many and One2Many fields are expanded into separate rows.
ShowParameterizedTables	Show tables that require inputs.
UseDisplayNames	Boolean determining if the display names for the columns should be used instead of the API names.

Miscellaneous

---

Property	Description
Language	This property specifies the language in which the data should be returned.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Odoo, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
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.
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.

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

---

Property	Description
URL	The base URL of the Odoo site you're connecting to. For example, http://my.odoo.com/.
Database	The name of the Odoo database you're connecting to.
OdooEdition	The edition of Odoo being used. Set either Odoo Online or Odoo On-Premise.
User	The Odoo user account used to authenticate.
APIToken	The API token (or password) used to authenticate the user.
CheckPermissions	Whether to use Odoo user's permissions to determine which tables and views to list.

The base URL of the Odoo site you're connecting to. For example, http://my.odoo.com/.

Data Type

string

Default Value

""

Remarks

The base URL of the Odoo site you're connecting to. For example, http://my.odoo.com/.

The name of the Odoo database you're connecting to.

Data Type

string

Default Value

""

Remarks

When connecting to Odoo online, this value is usually the name of your custom Odoo domain. For example, if you connect to https://contoso.odoo.com, then the Database will be contoso. This property will be interpreted from the URL property.

When connecting to an on-premise instance of Odoo, you can find this value by logging out of Odoo and opening the Manage Databases page from the login screen. There, you can determine the database you need to connect to.

The edition of Odoo being used. Set either Odoo Online or Odoo On-Premise.

Possible Values

Odoo Online

Data Type

string

Default Value

"Odoo Online"

Remarks

The edition of Odoo being used. Set either Odoo Online or Odoo On-Premise. When the OdooEdition is set to Odoo Online, the driver will consider the System's culture while processing the float/decimal/double data types for Insert statements.

The Odoo user account used to authenticate.

Data Type

string

Default Value

""

Remarks

Together with APIToken, this field is used to authenticate against the Odoo server.

The API token (or password) used to authenticate the user.

Data Type

string

Default Value

""

Remarks

When using Odoo 14 and above, this option can be set to either an API token or password. API tokens are recommended over passwords.

Whether to use Odoo user's permissions to determine which tables and views to list.

Data Type

bool

Default Value

true

Remarks

Each user in Odoo has different permissions to some models - they can modify some, read others, and may not be able to access some at all. When CheckPermissions is true (the default), the model permissions are examined so that modifiable models are classified as tables, read-only models are classified as views, and inaccessible models are not listed.

When CheckPermissions is false, all the models within Odoo are listed as tables and the permissions check is skipped.

Checking model permissions requires an administrator to grant your user read-only access to the "ir.model.access" model because it is not readable to most users by default. If access to that model cannot be granted to the connecting user, then set this option to false.

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

---

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

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.

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	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

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

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
AllowComputedFields	Boolean determining whether computed names from Odoo are mapped to columns.
ExpandReferences	Boolean determining if multi-valued Many2Many and One2Many fields are expanded into separate rows.
ShowParameterizedTables	Show tables that require inputs.
UseDisplayNames	Boolean determining if the display names for the columns should be used instead of the API names.

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.

Boolean determining whether computed names from Odoo are mapped to columns.

Data Type

bool

Default Value

false

Remarks

Internally, Odoo stores some fields directly in its database and computes other fields dynamically when you request them. While stored fields are usually fast to retrieve, computed fields can potentially be much slower since Odoo has to do additional work on each row.

By default, this property is false and computed fields are not available. You can set this property to true if you need to access a computed field, although this will make queries (including star queries) on many tables take longer to run.

Boolean determining if multi-valued Many2Many and One2Many fields are expanded into separate rows.

Data Type

bool

Default Value

false

Remarks

By default Many2Many and One2Many fields are collapsed into single values separated by commas. For example, a record in calendar_event IDs will generate a result like this if partners 13 and 57 are attending.

SELECT id, name,                           partner_ids, x_custom_ids FROM calendar_event
--      1  'Meet With Potential Customer'  '13,57'      '1,2'

With this option enabled, the Cloud will expand each combination of multi-valued field values across multiple rows. This means that row data will be duplicated but makes it simpler to JOIN between tables that are linked by multi-valued references.

In addition, the Cloud will use a separate primary key called id:multi since id) not unique when rows are duplciated. This primary key is generated client-side and its use should be avoided in filters, since it depends upon the exact rows returned by any filters evaluated by Odoo.

SELECT "id:multi", id, name,                          partner_ids, x_custom_ids FROM calendar_event
--      1:1        1  'Meet With Potential Customer'  13           1
--      1:2        1  'Meet With Potential Customer'  57           1
--      1:3        1  'Meet With Potential Customer'  13           2
--      1:4        1  'Meet With Potential Customer'  57           2

Note that this option does not affect how INSERTs are processed. If you want to insert a record containing a multi-valued field you must always insert using a comma-separated value.

Show tables that require inputs.

Data Type

bool

Default Value

false

Remarks

When this property is set to true, all the tables or views that require inputs to fetch data are displayed.

When this property is set to false, those tables and views are hidden.

The following is the complete list of tables that are shown/hidden based on the value of this property:

• calendar_alarm_manager
• forum_post
• ir_actions_act__window
• website_seo_metadata
• publisher_warranty_contract
• board_board
• hr_leave_report_calendar
• report_stock_quantity
• res_users_apikeys_show
• account_aged_payable
• account_aged_receivable
• account_multicurrency_revaluation

Boolean determining if the display names for the columns should be used instead of the API names.

Data Type

bool

Default Value

true

Remarks

Display names may be changed in the future. Set this to false if you would like to ensure column names are always constant.

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

---

Property	Description
Language	This property specifies the language in which the data should be returned.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Odoo, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
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.
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.

This property specifies the language in which the data should be returned.

Data Type

string

Default Value

""

Remarks

This property can take one of the following values:

en_us (default)	English (US)
es_MX	Spanish (MX) / Español (MX)
es_MX	Spanish (MX) / Español (MX)
sq_AL	Albanian / Shqip
am_ET	Amharic / አምሃርኛ
ar_SY	Arabic (Syria) / الْعَرَبيّة
ar_001	Arabic / الْعَرَبيّة
az_AZ	Azerbaijani / Azərbaycanca
eu_ES	Basque / Euskara
bn_IN	Bengali / বাংলা
bs_BA	Bosnian / bosanski jezik
bg_BG	Bulgarian / български език
my_MM	Burmese / ဗမာစာ
ca_ES	Catalan / Català
zh_HK	Chinese (HK)
zh_CN	Chinese (Simplified) / 简体中文
zh_TW	Chinese (Traditional) / 繁體中文
hr_HR	Croatian / hrvatski jezik
cs_CZ	Czech / Čeština
da_DK	Danish / Dansk
nl_BE	Dutch (BE) / Nederlands (BE)
nl_NL	Dutch / Nederlands
en_AU	English (AU)
en_CA	English (CA)
en_IN	English (IN)
en_NZ	English (NZ)
en_GB	English (UK)
et_EE	Estonian / Eesti keel
fi_FI	Finnish / Suomi
fr_BE	French (BE) / Français (BE)
fr_CA	French (CA) / Français (CA)
fr_CH	French (CH) / Français (CH)
fr_FR	French / Français
gl_ES	Galician / Galego
ka_GE	Georgian / ქართული ენა
de_CH	German (CH) / Deutsch (CH)
de_DE	German / Deutsch
el_GR	Greek / Ελληνικά
gu_IN	Gujarati / ગુજરાતી
he_IL	Hebrew / עִבְרִי
hi_IN	Hindi / हिंदी
hu_HU	Hungarian / Magyar
id_ID	Indonesian / Bahasa Indonesia
it_IT	Italian / Italiano
ja_JP	Japanese / 日本語
kab_DZ	Kabyle / Taqbaylit
km_KH	Khmer / ភាសាខ្មែរ
ko_KP	Korean (KP) / 한국어 (KP)
ko_KR	Korean (KR) / 한국어 (KR)
lo_LA	Lao / ພາສາລາວ
lv_LV	Latvian / latviešu valoda
lt_LT	Lithuanian / Lietuvių kalba
lb_LU	Luxembourgish
mk_MK	Macedonian / македонски јазик
ms_MY	Malay / Bahasa Melayu
ml_IN	Malayalam / മലയാളം
mn_MN	Mongolian / монгол
nb_NO	Norwegian Bokmål / Norsk bokmål
fa_IR	Persian / فارسی
pl_PL	Polish / Język polski
pt_AO	Portuguese (AO) / Português (AO)
pt_BR	Portuguese (BR) / Português (BR)
pt_PT	Portuguese / Português
ro_RO	Romanian / română
ru_RU	Russian / русский язык
sr_RS	Serbian (Cyrillic) / српски
sr@latin	Serbian (Latin) / srpski
sk_SK	Slovak / Slovenský jazyk
sl_SI	Slovenian / slovenščina
es_AR	Spanish (AR) / Español (AR)
es_BO	Spanish (BO) / Español (BO)
es_CL	Spanish (CL) / Español (CL)
es_CO	Spanish (CO) / Español (CO)
es_CR	Spanish (CR) / Español (CR)
es_DO	Spanish (DO) / Español (DO)
es_EC	Spanish (EC) / Español (EC)
es_GT	Spanish (GT) / Español (GT)
es_419	Spanish (Latin America) / Español (América Latina)
es_PA	Spanish (PA) / Español (PA)
es_PE	Spanish (PE) / Español (PE)
es_PY	Spanish (PY) / Español (PY)
es_UY	Spanish (UY) / Español (UY)
es_VE	Spanish (VE) / Español (VE)
es_ES	Spanish / Español
sv_SE	Swedish / Svenska
tl_PH	Tagalog / Filipino
te_IN	Telugu / తెలుగు
th_TH	Thai / ภาษาไทย
tr_TR	Turkish / Türkçe
uk_UA	Ukrainian / українська
vi_VN	Vietnamese / Tiếng Việt

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the maximum number of results to return from Odoo, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

5000

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

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.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

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 Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud 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 60 seconds 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.