Skip to content

Commit

Permalink
Move out of the main docs section
Browse files Browse the repository at this point in the history
  • Loading branch information
roji committed Nov 30, 2024
1 parent c869840 commit 7bbdd8e
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions conceptual/Npgsql/connection-string-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,16 +84,14 @@ Host Recheck Seconds | Controls for how long the host's cached state will b
Parameter | Description | Default
------------------------ | ---------------------------------------------------------------------------------------------------- | ----------
Options<sup>[1](#misc_sup_1)</sup> | Specifies any valid [PostgreSQL connection options](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-OPTIONS) (e.g. `Options=-c synchronous_commit=local`). Introduced in 5.0. | PGOPTIONS
Application Name | The optional application name parameter to be sent to the backend during connection initiation. |
Enlist | Whether to enlist in an ambient TransactionScope. | true
Search Path | Sets the schema search path. |
Client Encoding | Gets or sets the client_encoding parameter. | PGCLIENTENCODING, UTF8
Encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. | UTF8
Timezone | Gets or sets the session timezone. | PGTZ
EF Template Database | The database template to specify when creating a database in Entity Framework. Removed in 8.0. | template1
EF Admin Database | The database admin to specify when creating and dropping a database in Entity Framework. Removed in 8.0. | template1
Load Table Composites | Load table composite type definitions, and not just free-standing composite types. | false
Array Nullability Mode | Configure the way arrays of value types are returned when requested as object instances. Possible values are: `Never` (arrays of value types are always returned as non-nullable arrays), `Always` (arrays of value types are always returned as nullable arrays) and `PerInstance` (the type of array that gets returned is determined at runtime). | Never
Application Name | The optional application name parameter to be sent to the backend during connection initiation. |
Enlist | Whether to enlist in an ambient TransactionScope. | true
Search Path | Sets the schema search path. |
Client Encoding | Gets or sets the client_encoding parameter. | PGCLIENTENCODING, UTF8
Encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. | UTF8
Timezone | Gets or sets the session timezone. | PGTZ
Load Table Composites | Load table composite type definitions, and not just free-standing composite types. | false
Array Nullability Mode | Configure the way arrays of value types are returned when requested as object instances. Possible values are: `Never` (arrays of value types are always returned as non-nullable arrays), `Always` (arrays of value types are always returned as nullable arrays) and `PerInstance` (the type of array that gets returned is determined at runtime). | Never

<sup id="misc_sup_1">1</sup>The `Options` connection string parameter is essentially the string of command line options that get passed to the [`postgres`](https://www.postgresql.org/docs/current/app-postgres.html) program when the process is started.
It is most commonly used to set named run-time parameters via the `-c` option but other options can be used too (although not all of them make sense in that context).
Expand All @@ -106,11 +104,13 @@ Parameter | Description
------------------------- | ------------------------------------------------------------------------------------------------- | -------
Server Compatibility Mode | A compatibility mode for special PostgreSQL server types. Currently "Redshift" is supported, as well as "NoTypeLoading", which will bypass the normal type loading mechanism from the PostgreSQL catalog tables and supports a hardcoded list of basic types. | none

## Obsolete
## Obsolete/removed

Parameter | Description | Default
------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------
Internal Command Timeout | The time to wait (in seconds) while trying to execute an internal command before terminating the attempt and generating an error. -1 uses CommandTimeout, 0 means no timeout. | -1
EF Template Database | The database template to specify when creating a database in non-core Entity Framework. Removed in 8.0. | template1
EF Admin Database | The database admin to specify when creating and dropping a database in non-core Entity Framework. Removed in 8.0. | template1

## Environment variables

Expand Down

0 comments on commit 7bbdd8e

Please sign in to comment.