Cmdlets for EnterpriseDB

Build 21.0.7930

Parameters (Connect-EnterpriseDB Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Authentication


PropertyDescription
ServerThe host name or IP address of the server.
DatabaseThe name of the EnterpriseDB database.
UserThe EnterpriseDB user account used to authenticate.
PasswordThe password used to authenticate the user.
PortThe port number of the EnterpriseDB server.
UseSSLWhether SSL is enabled.
VisibilityVisibility restrictions used to filter exposed metadata for tables with privileges granted to them for current user.

SSL


PropertyDescription
SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
IgnoredSchemasVisibility restriction filter which is used to hide the list of schemas by metadata quering. For example, 'information_schema, pg_catalog'. Schema names are case sensitive.

Miscellaneous


PropertyDescription
AllowPreparedStatementPrepare a query statement before its execution.
FetchResultSetMetadataThis field sets whether the provider is getting detailed information about resultset columns from the server.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
QueryPassthroughThis option passes the query to the EnterpriseDB server as is.
ReadonlyYou can use this property to enforce read-only access to EnterpriseDB from the provider.
RTKThe runtime key used for licensing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TimeZoneNotifies the server about the time zone on the client with standard SET TIMEZONE query when connection is being opened.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930