Cmdlets for MarkLogic

Build 24.0.9060

CacheConnection Parameter (Connect-MarkLogic Cmdlet)

The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.

Syntax

Connect-MarkLogic -CacheConnection string

Data Type

cstr

Default Value

""

Remarks

The cache database is determined based on the CacheProvider and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheProvider.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheProvider. Consult the documentation for the specific ADO.NET provider for more information on the available properties.

SQLite

You can use the Microsoft ADO.NET Provider for SQLite to cache to SQLite databases. Specify the following:

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

MySQL

The installation includes the CData ADO.NET Provider for MySQL. The following are typical connection properties:

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The user name provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.

SQL Server

To cache to SQL Server, you can use the .NET Framework Provider for SQL Server, included in the .NET Framework. The following are typical SQL Server connection properties:

  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
  • User Id: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.

Oracle

To cache to Oracle, you can use the Oracle Data Provider for .NET. The following are typical connection properties:

  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

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

PostgreSQL

To cache to PostgreSQL, you can use the Npgsql ADO.NET provider. The following are typical connection properties:

  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • User name: The user Id provided for authentication with the PostgreSQL database.
  • Password: The password provided for authentication with the PostgreSQL database.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060