Establishing a Connection
The objects available within our connector are accessible from the "cdata.marklogic" module. To use the module's objects directly:
- Import the module as follows:
import cdata.marklogic as mod
- To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
mod.connect("User='myusername';Password='mypassword';Server='marklogic'")
Connecting to MarkLogic
Picking an API
The CData Python Connector for MarkLogic offers access to both the REST and ODBC APIs for MarkLogic. Please see Picking the right API for a discussion on which API is right for your use case.
Connection Details
Regardless of which API you are connecting to, you will need to include the following connection details:
- Server - The server being connected to.
- Database - (Optional) The specific database to connect to.
- Port - (Optional) The specific port to use if the default port for the selected API is not being used default.
Create an ODBC Server
If connecting to the ODBC API, please follow the guide in MarkLogic's official website on how to create an ODBC Server, https://docs.marklogic.com/guide/admin/odbc.
Authenticating to MarkLogic
To authenticate to MarkLogic, specify the following connection properties:
- User - The user to authenticate as.
- Password - The password of the user.