Parameters (Connect-OracleOci Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| ConnectionType | Connection properties to use for authentication. Accepted entries are Server, OracleTNS, LDAP. |
| Server | The host name or IP of the server hosting the Oracle database. |
| Port | The port used to connect to the server hosting the Oracle database. |
| ServiceName | The service name of the Oracle database. |
| User | The Oracle OCI user account used to authenticate. |
| Password | The password used to authenticate the user. |
| DataSource | Oracle Net Services Name, Connect Descriptor (known also as TNS Connect String), or an easy connect naming that identifies the database to which to connect. |
| LDAPUri | LDAP uri to connect the LDAP server. |
| LDAPUser | The User account for LDAP server. |
| LDAPPassword | The password for the LDAP user. |
| LDAPVersion | The LDAP version used to connect to and communicate with the server. |
| Wallet | The location of the client's wallet that os required to setup secure TCPS connection. |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| IncludeSynonyms | Query metadata for synonyms as though they are the original tables. |
| ShowMetadataDescriptions | Controls whether table and column descriptions are returned via the platform metadata APIs and sys_tables / sys_views / sys_tablecolumns. |
| UseDBAMetadataViews | Query meta data from DBA_.. system views instead of ALL_.. system views. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| AllowPreparedStatement | Prepare a query statement before its execution. |
| MaxLobSize | The volume in numbers of bytes or UTF-8 chars which is allowed to query by non-parameterized SELECT query. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| NativeFolder | The path to the directory containing the native dlls the provider works with. This property is effective on the Windows and macOS platforms only. |
| Other | These hidden properties are used only in specific use cases. |
| QueryPassthrough | This option passes the query to the Oracle OCI server as is. |
| Readonly | You can use this property to enforce read-only access to Oracle OCI from the provider. |
| ReconnectTimeout | The sleep time, in seconds, before retrying to reconnect to the server on a maximum idle time exceeded error. |
| ReconnectTries | The number of retry to connect server when a maximum idle time exceeded error is reported by server. |
| RTK | The runtime key used for licensing. |