Postgres Dart Package

https://pub.dev/documentation/postgres/latest/
Admin
A Dart library for connecting to and querying PostgreSQL databases using the efficient and secure...
Tokens:106,133
Snippets:1,446
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Schema Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/ResultStreamSubscription/schema.html

This snippet shows the implementation of the `get schema` property, which returns a Future of ResultSchema.

```dart
Future<ResultSchema> get schema;
```

--------------------------------

### asBytes Method

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage-class.html

Converts the StartupMessage into a Uint8List of bytes using the specified encoding.

```APIDOC
## asBytes Method

### Description
Converts the StartupMessage into a Uint8List of bytes using the specified encoding.

### Parameters
- **encoding** (Encoding) - Required - The character encoding to use for the conversion.

### Returns
- Uint8List
```

--------------------------------

### ConnectionInfo Constructors

Source: https://pub.dev/documentation/postgres/latest/postgres/ConnectionInfo-class.html

Initializes a new instance of the ConnectionInfo class. Optionally accepts a map of string parameters.

```APIDOC
## ConnectionInfo

### Description
Provides runtime information about the current connection.

### Constructors

#### ConnectionInfo

* **parameters** (Map<String, String>?): An optional map of string key-value pairs representing connection parameters.
```

--------------------------------

### Get Future for Session Closure

Source: https://pub.dev/documentation/postgres/latest/postgres/Session/closed.html

Use this property to get a Future that completes when the session is closed. This is part of the session management API.

```dart
Future<void> get closed;
```

--------------------------------

### Get Range Flag Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Range/flag.html

This C# code snippet shows the implementation of the `get flag` property for a range type. It determines the flag value based on the nullability and values of the lower and upper bounds.

```C#
int get flag {
  switch ((lower == null, upper == null)) {
    case (true, true):
      return 24;
    case (true, false):
      return 8 + bounds._upperFlag;
    case (false, true):
      return 16 + bounds._lowerFlag;
    case (false, false):
      return lower == upper ? 1 : bounds._lowerFlag + bounds._upperFlag;
  }
}
```

--------------------------------

### Connection Constructors

Source: https://pub.dev/documentation/postgres/latest/postgres/Connection-class.html

Provides information about how to create a new Connection instance.

```APIDOC
## Constructors

### Connection()

Creates a new instance of the Connection class.
```

--------------------------------

### StartupMessage Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage-class.html

Constructs a StartupMessage object. It requires database and timeZone, and optionally accepts username, applicationName, and replication mode.

```APIDOC
## StartupMessage Constructor

### Description
Constructs a StartupMessage object. It requires database and timeZone, and optionally accepts username, applicationName, and replication mode.

### Parameters
- **database** (String) - Required - The database identifier.
- **timeZone** (String) - Required - The timezone for the message.
- **username** (String?) - Optional - The username associated with the message.
- **applicationName** (String?) - Optional - The name of the application sending the message.
- **replication** (ReplicationMode) - Optional - The replication mode, defaults to ReplicationMode.none.
```

--------------------------------

### Get Column Count

Source: https://pub.dev/documentation/postgres/latest/messages/TupleData/columnCount.html

Assigns the number of columns to the columnCount variable.

```Dart
late final int columnCount = columns.length;
```

--------------------------------

### CopyDataMessage.bytes Property

Source: https://pub.dev/documentation/postgres/latest/messages/CopyDataMessage-class.html

Gets the data that forms part of a COPY data stream.

```APIDOC
## bytes → Uint8List

### Description
Represents the data payload of the COPY data stream. Messages from the backend typically correspond to single data rows, while frontend messages may divide the data stream arbitrarily.

### Type
Uint8List
```

--------------------------------

### StartupMessage Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage/StartupMessage.html

Shows the internal implementation of the StartupMessage constructor, initializing private fields.

```dart
StartupMessage({
  required String database,
  required String timeZone,
  String? username,
  String? applicationName,
  ReplicationMode replication = ReplicationMode.none,
}) : _databaseName = database,
     _timeZone = timeZone,
     _username = username,
     _applicationName = applicationName,
     _replication = replication.value;
```

--------------------------------

### Get Lower Bound

Source: https://pub.dev/documentation/postgres/latest/postgres/Range/lower.html

Retrieves the lower bound of a range. The return type is nullable.

```APIDOC
## get lower

### Description
Retrieves the lower bound of a range. The return type is nullable.

### Method
GET

### Endpoint
/range/{range_id}/lower

### Parameters
#### Path Parameters
- **range_id** (string) - Required - The identifier of the range.

### Response
#### Success Response (200)
- **value** (any) - The lower bound of the range. This can be null if the range is unbounded below.

#### Response Example
```json
{
  "value": "2023-01-01"
}
```
```

--------------------------------

### applyToBuffer

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage/applyToBuffer.html

Applies the startup message details to a PgByteDataWriter buffer. This method serializes connection parameters like client encoding, database name, timezone, username, replication mode, and application name into a buffer according to a specific protocol.

```APIDOC
## applyToBuffer

### Description
Applies the startup message details to a PgByteDataWriter buffer. This method serializes connection parameters like client encoding, database name, timezone, username, replication mode, and application name into a buffer according to a specific protocol.

### Method
void

### Parameters
#### Path Parameters
* **buffer** (PgByteDataWriter) - Required - The buffer to which the startup message will be written.

### Request Example
```dart
// Example usage within a class that has _databaseName, _timeZone, _username, _replication, _applicationName fields
final writer = PgByteDataWriter();
applyToBuffer(writer);
```

### Response
This method does not return a value directly, but modifies the provided buffer.
```

--------------------------------

### applyToBuffer Method

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage-class.html

Applies the StartupMessage to a provided PgByteDataWriter buffer.

```APIDOC
## applyToBuffer Method

### Description
Applies the StartupMessage to a provided PgByteDataWriter buffer.

### Parameters
- **buffer** (PgByteDataWriter) - Required - The buffer to which the message will be applied.

### Returns
- void
```

--------------------------------

### Get p1 Property

Source: https://pub.dev/documentation/postgres/latest/postgres/Box/p1.html

Retrieves the value of the p1 property. This is a direct getter implementation.

```dart
Point get p1 => _p1;
```

--------------------------------

### Get Second from UTC DateTime

Source: https://pub.dev/documentation/postgres/latest/postgres/Time/second.html

Retrieves the second component (0-59) from a UTC DateTime object.

```dart
int get second => utcDateTime.second;
```

--------------------------------

### open static method

Source: https://pub.dev/documentation/postgres/latest/postgres/Connection/open.html

Opens a new PostgreSQL connection to the specified endpoint with optional connection settings.

```APIDOC
## open static method

### Description
Opens a new PostgreSQL connection to the specified endpoint with optional connection settings.

### Method
static

### Signature
Future<Connection> open(Endpoint endpoint, {ConnectionSettings? settings})

### Parameters
#### Path Parameters
- **endpoint** (Endpoint) - Required - The endpoint to connect to.
- **settings** (ConnectionSettings?) - Optional - The connection settings to use.
```

--------------------------------

### Get Channels Property

Source: https://pub.dev/documentation/postgres/latest/postgres/Connection/channels.html

This snippet shows the basic syntax for retrieving the channels property in PostgreSQL.

```sql
Channels get channels;
```

--------------------------------

### StartupMessage Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage/StartupMessage.html

Initializes a new instance of the StartupMessage class.

```APIDOC
## StartupMessage Constructor

### Description
Initializes a new instance of the StartupMessage class with specified database, timezone, and optional user-related information.

### Parameters
#### Constructor Parameters
- **database** (String) - Required - The name of the database.
- **timeZone** (String) - Required - The timezone for the message.
- **username** (String?) - Optional - The username associated with the message.
- **applicationName** (String?) - Optional - The name of the application.
- **replication** (ReplicationMode) - Optional - The replication mode, defaults to ReplicationMode.none.
```

--------------------------------

### Get WAL Data Length

Source: https://pub.dev/documentation/postgres/latest/messages/XLogDataLogicalMessage/walDataLength.html

Retrieves the length of WAL data. This is part of the LSN implementation.

```dart
@override
LSN get walDataLength => LSN(bytes.length);
```

--------------------------------

### Initialize typeOids List

Source: https://pub.dev/documentation/postgres/latest/messages/ParameterDescriptionMessage/typeOids.html

Demonstrates the initialization of an empty list for typeOids.

```dart
final typeOids = <int>[];
```

--------------------------------

### DatabaseInfo()

Source: https://pub.dev/documentation/postgres/latest/postgres/DatabaseInfo-class.html

Constructs a new DatabaseInfo instance.

```APIDOC
## DatabaseInfo()

### Description
Constructs a new DatabaseInfo instance.

### Method
Constructor

### Endpoint
N/A
```

--------------------------------

### runtimeType → Type

Source: https://pub.dev/documentation/postgres/latest/messages/ParseCompleteMessage-class.html

Gets the runtime type of the ParseCompleteMessage object. This property is inherited and has no setter.

```APIDOC
## runtimeType

### Description

Returns a representation of the runtime type of this object. This is a standard Object property and cannot be modified.

### Property Type

Type

### Access

Read-only (no setter)
```

--------------------------------

### hashCode → int

Source: https://pub.dev/documentation/postgres/latest/messages/ParseCompleteMessage-class.html

Gets the hash code for the ParseCompleteMessage object. This property is inherited and has no setter.

```APIDOC
## hashCode

### Description

Returns the hash code for this object. This is a standard Object property and cannot be modified.

### Property Type

int

### Access

Read-only (no setter)
```

--------------------------------

### ConnectionInfo Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/ConnectionInfo/ConnectionInfo.html

Initializes ConnectionInfo with optional parameters. The parameters are wrapped in a ConnectionParametersView.

```dart
ConnectionInfo({Map<String, String>? parameters})
  : parameters = ConnectionParametersView(values: parameters);
```

--------------------------------

### Get Microsecond from Timestamp

Source: https://pub.dev/documentation/postgres/latest/postgres/Time/microsecond.html

Retrieves the microsecond component from a UTC timestamp. The value is an integer between 0 and 999.

```dart
int get microsecond => utcDateTime.microsecond;
```

--------------------------------

### PostgreSQL Connection Open Method Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Connection/open.html

This snippet shows the implementation of the static `open` method, which uses `PgConnectionImplementation.connect` to establish a connection with the provided endpoint and settings.

```dart
static Future<Connection> open(
  Endpoint endpoint, {
  ConnectionSettings? settings,
}) {
  return PgConnectionImplementation.connect(
    endpoint,
    connectionSettings: settings,
  );
}
```

--------------------------------

### Get Upper Bound of a Range

Source: https://pub.dev/documentation/postgres/latest/postgres/Range/upper.html

Retrieves the upper bound of a PostgreSQL range. This property is directly accessible.

```Dart
T? get upper => _upper;
```

--------------------------------

### DescribeMessage.portal Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/DescribeMessage/DescribeMessage.portal.html

Initializes a new instance of the DescribeMessage.portal class with a specified portal name.

```APIDOC
## DescribeMessage.portal Constructor

### Description
Initializes a new instance of the DescribeMessage.portal class with a specified portal name.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Method Signature
```dart
DescribeMessage.portal({String portalName = ''})
```

### Parameters
- **portalName** (String) - Optional - The name of the portal.

### Implementation
```dart
DescribeMessage.portal({String portalName = ''})
  : _name = portalName,
    _isPortal = true;
```
```

--------------------------------

### Get Bounds Property

Source: https://pub.dev/documentation/postgres/latest/postgres/Range/bounds.html

Retrieves the bounds of a PostgreSQL range. This is a direct getter for the internal bounds representation.

```dart
Bounds get bounds => _bounds;
```

--------------------------------

### PoolSettings Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/PoolSettings/PoolSettings.html

Provides the implementation details for the PoolSettings constructor, showing how the provided parameters are assigned to instance variables.

```dart
const PoolSettings({
  this.maxConnectionCount,
  this.maxConnectionAge,
  this.maxSessionUse,
  this.maxQueryCount,
  super.applicationName,
  super.connectTimeout,
  super.sslMode,
  super.securityContext,
  super.encoding,
  super.timeZone,
  super.replicationMode,
  super.transformer,
  super.queryTimeout,
  super.queryMode,
  super.ignoreSuperfluousParameters,
  super.onOpen,
  super.typeRegistry,
});
```

--------------------------------

### Get p2 Property

Source: https://pub.dev/documentation/postgres/latest/postgres/Box/p2.html

Retrieves the value of the p2 property. This is a direct getter for the internal _p2 variable.

```dart
Point get p2 => _p2;
```

--------------------------------

### Declare and Initialize a Constant

Source: https://pub.dev/documentation/postgres/latest/messages/ClientMessageId/describe-constant.html

Demonstrates how to declare and initialize a static constant integer in C++.

```c++
static const int describe = 68;
```

--------------------------------

### Declare ResultSchema

Source: https://pub.dev/documentation/postgres/latest/postgres/Result/schema.html

Declares a variable of type ResultSchema. This is a common starting point for working with query results.

```java
final ResultSchema schema;

```

--------------------------------

### ClientMessageFormat Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/ClientMessageFormat/ClientMessageFormat.html

Initializes a new instance of the ClientMessageFormat class.

```APIDOC
## ClientMessageFormat()

### Description
Initializes a new instance of the ClientMessageFormat class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
Initializes a new ClientMessageFormat object.

#### Response Example
N/A
```

--------------------------------

### Get Affected Rows

Source: https://pub.dev/documentation/postgres/latest/postgres/ResultStreamSubscription/affectedRows.html

Retrieves the number of rows affected by the last database operation. This is a Future that resolves to an integer.

```dart
Future<int> get affectedRows;
```

--------------------------------

### openFromUrl static method

Source: https://pub.dev/documentation/postgres/latest/postgres/Connection/openFromUrl.html

Opens a new PostgreSQL connection by parsing a connection URL. The URL format is `postgresql://[userspec@][hostspec][/dbname][?paramspec]`. Only the first endpoint is used if multiple are provided, and only a subset of settings can be configured via URL parameters.

```APIDOC
## openFromUrl static method

### Description
Opens a new PostgreSQL connection using a connection string formatted as a URL. The URL specifies connection details like user, host, database, and parameters.

### Method Signature
`static Future<Connection> openFromUrl(String connectionString)`

### Parameters
#### Path Parameters
- **connectionString** (String) - Required - The URL string for the PostgreSQL connection. Format: `postgresql://[userspec@][hostspec][/dbname][?paramspec]`

### Notes
- If multiple endpoints are specified in the URL, only the first one will be used.
- Only a subset of connection settings can be configured using parameters within the URL.
```

--------------------------------

### Get Polygon Points

Source: https://pub.dev/documentation/postgres/latest/postgres/Polygon/points.html

Retrieves the list of points that constitute the polygon. This is a getter method for the internal points list.

```dart
List<Point> get points => _points;
```

--------------------------------

### CodecContext Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/CodecContext/CodecContext.html

Initializes a new CodecContext with necessary connection and database information, encoding, and type registry.

```APIDOC
## CodecContext constructor

### Description
Initializes a new CodecContext with the provided connection information, database details, encoding, and type registry.

### Parameters
- **connectionInfo** (ConnectionInfo) - Required - Information about the database connection.
- **databaseInfo** (DatabaseInfo) - Required - Information about the database itself.
- **encoding** (Encoding) - Required - The character encoding to be used.
- **typeRegistry** (TypeRegistry) - Required - The registry for handling PostgreSQL data types.

### Implementation
```dart
CodecContext({
  required this.connectionInfo,
  required this.databaseInfo,
  required this.encoding,
  required this.typeRegistry,
});
```
```

--------------------------------

### Get minute from UTC DateTime

Source: https://pub.dev/documentation/postgres/latest/postgres/Time/minute.html

Retrieves the minute component from a UTC DateTime object. The minute is an integer between 0 and 59.

```dart
int get minute => utcDateTime.minute;
```

--------------------------------

### Open a PostgreSQL Connection

Source: https://pub.dev/documentation/postgres/latest

Establishes a new connection to a PostgreSQL database using endpoint details. Ensure the 'postgres' package is imported.

```dart
import 'package:postgres/postgres.dart';

// ...

final conn = await Connection.open(Endpoint(
  host: 'localhost',
  database: 'postgres',
  username: 'user',
  password: 'pass',
));
```

--------------------------------

### Pool.withUrl Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/Pool/Pool.withUrl.html

Creates a new PostgreSQL connection pool where connection details and settings are provided via a URL. The URL format is `postgresql://[userspec@][hostspec][/dbname][?paramspec]`. It supports multiple endpoints and a subset of settings configurable via URL parameters.

```APIDOC
## Pool.withUrl Constructor

### Description
Creates a new PostgreSQL pool where the endpoint and settings are encoded as a URL.

### Method
Factory Constructor

### Signature
Pool.withUrl(String connectionString)

### Parameters
#### Path Parameters
- **connectionString** (String) - Required - The connection URL string in the format `postgresql://[userspec@][hostspec][/dbname][?paramspec]`.

### Notes
- Multiple endpoints can be specified via comma-separated hosts or multiple host query parameters.
- Only a subset of settings can be set with parameters in the URL.
```

--------------------------------

### Get millisecond from UTC DateTime

Source: https://pub.dev/documentation/postgres/latest/postgres/Time/millisecond.html

Accesses the millisecond component of a UTC DateTime object. The value ranges from 0 to 999.

```Dart
int get millisecond => utcDateTime.millisecond;
```

--------------------------------

### Get ignoreCertificateIssues Property

Source: https://pub.dev/documentation/postgres/latest/postgres/SslMode/ignoreCertificateIssues.html

Retrieves the boolean value of the ignoreCertificateIssues property. This property is true if the SSL mode is set to require.

```dart
bool get ignoreCertificateIssues => this == SslMode.require;
```

--------------------------------

### Declare and Initialize Constant Integer

Source: https://pub.dev/documentation/postgres/latest/messages/ClientMessageId/parse-constant.html

Demonstrates the declaration and initialization of a static constant integer.

```cpp
static const int parse = 80;
```

--------------------------------

### ConnectionInfo Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/ConnectionInfo/ConnectionInfo.html

Constructs a new ConnectionInfo object with optional connection parameters.

```APIDOC
## ConnectionInfo Constructor

### Description
Initializes a new instance of the ConnectionInfo class, allowing for the configuration of connection parameters.

### Method
Constructor

### Parameters
#### Named Parameters
- **parameters** (Map<String, String>?): An optional map of connection parameters. Keys are parameter names (e.g., 'host', 'port', 'database'), and values are their corresponding string values.
```

--------------------------------

### Get WAL Data Length

Source: https://pub.dev/documentation/postgres/latest/messages/XLogDataMessage/walDataLength.html

Retrieves the length of WAL data in bytes. This is useful for determining the size of WAL segments.

```Dart
LSN get walDataLength => LSN(bytes.length);
```

--------------------------------

### Get Data Property for Physical Replication

Source: https://pub.dev/documentation/postgres/latest/messages/XLogDataMessage/data.html

Retrieves the raw bytes for physical replication. For logical replication, refer to XLogDataLogicalMessage.

```dart
Object get data => bytes;
```

--------------------------------

### StartupMessage Constructor Signature

Source: https://pub.dev/documentation/postgres/latest/messages/StartupMessage/StartupMessage.html

Defines the parameters for the StartupMessage constructor, including required and optional fields.

```dart
StartupMessage({
  required String database,
  required String timeZone,
  String? username,
  String? applicationName,
  ReplicationMode replication = ReplicationMode.none,
})
```

--------------------------------

### BadCertificateException Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/BadCertificateException-class.html

Initializes a new instance of the BadCertificateException class with the provided X509Certificate.

```APIDOC
## BadCertificateException(X509Certificate certificate)

### Description
Constructs a new BadCertificateException with the given certificate.

### Parameters
#### Path Parameters
- **certificate** (X509Certificate) - Required - The X509Certificate that failed validation.
```

--------------------------------

### Initialize relationIds List

Source: https://pub.dev/documentation/postgres/latest/messages/TruncateMessage/relationIds.html

Initializes an empty list of integers for relationIds. This is a common starting point for managing related identifiers.

```dart
final relationIds = <int>[];
```

--------------------------------

### Initialize columnsFormatCode

Source: https://pub.dev/documentation/postgres/latest/messages/CopyBothResponseMessage/columnsFormatCode.html

Initializes an empty list for the columnsFormatCode property. This is a common starting point for defining column format codes.

```dart
final columnsFormatCode = <int>[];
```

--------------------------------

### Path Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Path/Path.html

Provides the implementation of the Path constructor, initializing the points and the open status.

```dart
Path(super.points, {required this.open});
```

--------------------------------

### Initialize baseMessage

Source: https://pub.dev/documentation/postgres/latest/messages/BeginMessage/baseMessage.html

Assigns the begin message type to the baseMessage property. This is used to indicate the start of a logical replication message.

```dart
late final baseMessage = LogicalReplicationMessageTypes.begin;
```

--------------------------------

### DescribeMessage.portal Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/messages/DescribeMessage/DescribeMessage.portal.html

Initializes the DescribeMessage.portal object with a given portal name and sets its internal portal status.

```dart
DescribeMessage.portal({String portalName = ''})
  : _name = portalName,
    _isPortal = true;
```

--------------------------------

### Connection Static Methods

Source: https://pub.dev/documentation/postgres/latest/postgres/Connection-class.html

Provides static methods for opening new PostgreSQL connections.

```APIDOC
## Static Methods

### open(Endpoint endpoint, {ConnectionSettings? settings}) → Future<Connection>

Opens a new connection to the PostgreSQL database using the provided `endpoint` and optional `settings`.

### openFromUrl(String connectionString) → Future<Connection>

Opens a new connection from a given `connectionString`. The connection string should be in the format `postgresql://[userspec@][hostspec][/dbname][?paramspec]`.
```

--------------------------------

### Get UTC DateTime Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Time/utcDateTime.html

This snippet shows the Dart implementation for retrieving the current UTC date and time from a DateTime object.

```dart
DateTime get utcDateTime =>
    DateTime.fromMicrosecondsSinceEpoch(microseconds, isUtc: true);
```

--------------------------------

### Endpoint Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/Endpoint-class.html

Initializes a new Endpoint instance to connect to a PostgreSQL database. It allows specifying connection details such as host, port, database name, username, and password.

```APIDOC
## Endpoint Constructor

### Description
Initializes a new Endpoint instance to connect to a PostgreSQL database. It allows specifying connection details such as host, port, database name, username, and password.

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Signature
```dart
Endpoint({required String host, int port = 5432, required String database, String? username, String? password, bool isUnixSocket = false})
```

### Properties
- **host** (String) - Required - The hostname of the database server.
- **port** (int) - Optional, defaults to 5432 - The port number of the database server.
- **database** (String) - Required - The name of the database to connect to.
- **username** (String?) - Optional - The username for authentication.
- **password** (String?) - Optional - The password for authentication.
- **isUnixSocket** (bool) - Optional - Specifies if the connection should use a Unix domain socket.
```

--------------------------------

### CopyBothResponseMessage

Source: https://pub.dev/documentation/postgres/latest/messages/CopyBothResponseMessage-class.html

Represents a Start Copy Both response message used in Streaming Replication. It defines properties for column and overall copy formats.

```APIDOC
## CopyBothResponseMessage Class

Identifies the message as a Start Copy Both response. This message is used only for Streaming Replication.

### Properties

*   **columnsFormatCode** (List<int>) - The format codes to be used for each column. Each must presently be zero (text) or one (binary). All must be zero if the overall copy format is textual.
*   **copyFormat** (int) - 0 indicates the overall COPY format is textual (rows separated by newlines, columns separated by separator characters, etc). 1 indicates the overall copy format is binary (similar to DataRow format).

### Methods

*   **toString()** (String) - A string representation of this object.
*   **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed.
```

--------------------------------

### LineSegment toString Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/LineSegment/toString.html

Overrides the default toString method to provide a custom string representation of a LineSegment object, including its start and end points.

```dart
@override
String toString() => 'LineSegment($p1,$p2)';
```

--------------------------------

### run<R> abstract method

Source: https://pub.dev/documentation/postgres/latest/postgres/Pool/run.html

Obtains a Session capable of running statements and calls `fn` with it. Returns the result (either the value or an error) of invoking `fn`. No updates will be reverted in the event of an error.

```APIDOC
## run<R> abstract method

### Description
Obtains a Session capable of running statements and calls `fn` with it. Returns the result (either the value or an error) of invoking `fn`. No updates will be reverted in the event of an error.

### Method Signature
```dart
Future<R> run<R>(
  Future<R> fn(Session session),
  {SessionSettings? settings, L? locality}
)
```

### Parameters
#### Function Parameter `fn`
- **session** (Session) - The database session object to be used within the function.

#### Optional Named Parameters
- **settings** (SessionSettings?) - Optional settings for the session.
- **locality** (L?) - Optional locality information for the session.
```

--------------------------------

### run<R> abstract method

Source: https://pub.dev/documentation/postgres/latest/postgres/SessionExecutor/run.html

Obtains a Session capable of running statements and calls `fn` with it. Returns the result (either the value or an error) of invoking `fn`. No updates will be reverted in the event of an error.

```APIDOC
## run<R> abstract method

### Description
Obtains a Session capable of running statements and calls `fn` with it. Returns the result (either the value or an error) of invoking `fn`. No updates will be reverted in the event of an error.

### Method Signature
Future<R> run<R>(Future<R> Function(Session session) fn, {SessionSettings? settings})

### Parameters
#### Function Parameter `fn`
- **session** (Session) - The database session object provided to the function.

#### Optional Named Parameter `settings`
- **settings** (SessionSettings?) - Optional settings for the session.

### Returns
- Future<R> - The result of the invoked function `fn`.
```

--------------------------------

### Get All Notifications Stream

Source: https://pub.dev/documentation/postgres/latest/postgres/Channels/all.html

This code snippet shows the declaration of the 'all' property, which returns a stream of Notification objects. It is used to listen to all notifications delivered from the server.

```dart
Stream<Notification> get all;
```

--------------------------------

### Create a Connection Pool from URL

Source: https://pub.dev/documentation/postgres/latest

Initializes a connection pool using a PostgreSQL connection string URL. Allows configuration of pool-specific parameters like max connections and age.

```dart
Pool.withUrl(
  'postgresql://localhost/mydb?max_connection_count=10&max_connection_age=3600'
);
```

--------------------------------

### Retrieve LogicalReplicationMessageTypes by ID

Source: https://pub.dev/documentation/postgres/latest/messages/LogicalReplicationMessageTypes/fromId.html

Use this static method to get a LogicalReplicationMessageTypes enum value from its string identifier. If the ID does not match any known type, it defaults to LogicalReplicationMessageTypes.unsupported.

```dart
static LogicalReplicationMessageTypes fromId(String id) {
  return LogicalReplicationMessageTypes.values.firstWhere(
    (element) => element.id == id,
    orElse: () => LogicalReplicationMessageTypes.unsupported,
  );
}
```

--------------------------------

### Get Hour Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Time/hour.html

This snippet shows how the hour property is implemented. It returns 24 for a full day's microseconds, otherwise it returns the hour from the UTC date time.

```Dart
int get hour =>
    microseconds == Duration.microsecondsPerDay ? 24 : utcDateTime.hour;
```

--------------------------------

### ConnectionSettings Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/ConnectionSettings/ConnectionSettings.html

Defines the parameters for creating a ConnectionSettings object, which configures how a PostgreSQL connection is established. Includes options for application name, time zone, encoding, SSL mode, and various timeouts.

```dart
const ConnectionSettings({
  this.applicationName,
  this.timeZone,
  this.encoding,
  this.sslMode,
  this.transformer,
  this.replicationMode,
  this.typeRegistry,
  this.securityContext,
  this.onOpen,
  super.connectTimeout,
  super.queryTimeout,
  super.queryMode,
  super.ignoreSuperfluousParameters,
});
```

--------------------------------

### TupleDataType Static Method: fromId

Source: https://pub.dev/documentation/postgres/latest/messages/TupleDataType.html

Converts a string ID to a TupleDataType enum value. Use this method when you have the string identifier for a data type and need to get the corresponding enum.

```dart
fromId(String id)
```

--------------------------------

### Declare and Initialize Query Constant

Source: https://pub.dev/documentation/postgres/latest/messages/ClientMessageId/query-constant.html

Demonstrates how to declare and initialize a constant integer variable named 'query' with a value of 81.

```C++
static const int query = 81;
```

--------------------------------

### PoolSettings Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/PoolSettings-class.html

Initializes a new instance of the PoolSettings class with specified connection pooling and session parameters.

```APIDOC
## PoolSettings Constructor

### Description
Initializes a new instance of the PoolSettings class with specified connection pooling and session parameters.

### Parameters

- **maxConnectionCount** (int?) - Optional - The maximum number of concurrent sessions.
- **maxConnectionAge** (Duration?) - Optional - The maximum duration a connection is kept open. New sessions won't be scheduled after this limit is reached.
- **maxSessionUse** (Duration?) - Optional - The maximum duration a connection is used by sessions. New sessions won't be scheduled after this limit is reached.
- **maxQueryCount** (int?) - Optional - The maximum number of queries to be run on a connection. New sessions won't be scheduled after this limit is reached.
- **applicationName** (String?) - Optional - The application name to be used for the connection.
- **connectTimeout** (Duration?) - Optional - The connection timeout duration.
- **sslMode** (SslMode?) - Optional - The SSL mode for the connection.
- **securityContext** (SecurityContext?) - Optional - The SecurityContext to use when opening a connection.
- **encoding** (Encoding?) - Optional - The encoding to use for the connection.
- **timeZone** (String?) - Optional - The time zone for the connection.
- **replicationMode** (ReplicationMode?) - Optional - The replication mode for connecting in streaming replication mode.
- **transformer** (StreamChannelTransformer<Message, Message>?) - Optional - An optional `StreamChannelTransformer` sitting behind the postgres client.
- **queryTimeout** (Duration?) - Optional - The query timeout duration.
- **queryMode** (QueryMode?) - Optional - The Query Execution Mode.
- **ignoreSuperfluousParameters** (bool?) - Optional - When set, the default query map will not throw an exception when superfluous parameters are found.
- **onOpen** (Future<void> Function(Connection connection)?) - Optional - A callback function that will be called after opening the connection.
- **typeRegistry** (TypeRegistry?) - Optional - When set, use the type registry with custom types, instead of the built-in ones provided by the package.
```

--------------------------------

### Stream<Notification> get all

Source: https://pub.dev/documentation/postgres/latest/postgres/Channels/all.html

Provides a stream of all notifications delivered from the server. This stream can be used to listen to notifications that have been manually subscribed to. The `[]` operator on Channels can be used to register subscriptions to notifications only when a stream is being listened to.

```APIDOC
## Stream<Notification> get all

### Description
A stream of all notifications delivered from the server. This stream can be used to listen to notifications manually subscribed to. The `[]` operator on Channels can be used to register subscriptions to notifications only when a stream is being listened to.

### Method
Stream

### Endpoint
N/A (SDK method)

### Implementation
```dart
Stream<Notification> get all;
```
```

--------------------------------

### LineSegment Equality Operator Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/LineSegment/operator_equals.html

This snippet shows the implementation of the equality operator for the LineSegment class. It checks if two LineSegment objects are identical or if they represent the same segment by comparing their start and end points.

```dart
@override
bool operator ==(Object other) =>
    identical(this, other) ||
    other is LineSegment && p1 == other.p1 && p2 == other.p2;
```

--------------------------------

### Session Class Methods

Source: https://pub.dev/documentation/postgres/latest/postgres/Session-class.html

Provides documentation for the methods available on the Session class, including query execution and statement preparation.

```APIDOC
## Session()

### Description
Constructor for the Session class.

## execute(Object query, {Object? parameters, bool ignoreRows = false, QueryMode? queryMode, Duration? timeout}) → Future<Result>

### Description
Executes the `query` with the given `parameters`.

### Parameters
- **query** (Object) - The SQL query to execute.
- **parameters** (Object?) - Optional parameters for the query.
- **ignoreRows** (bool) - Optional. If true, rows returned by the query will be ignored. Defaults to false.
- **queryMode** (QueryMode?) - Optional. Specifies the mode for query execution.
- **timeout** (Duration?) - Optional. Specifies the timeout for the query execution.

### Returns
A Future that completes with a `Result` object.

## prepare(Object query) → Future<Statement>

### Description
Prepares a reusable statement from a `query`.

### Parameters
- **query** (Object) - The SQL query to prepare.

### Returns
A Future that completes with a `Statement` object.
```

--------------------------------

### Get Column Type OID by Relation ID and Column Index

Source: https://pub.dev/documentation/postgres/latest/postgres/DatabaseInfo/getColumnTypeOidByRelationIdAndColumnIndex.html

Retrieves the type OID for a specified relation ID and column index. Returns null if the relation ID is not found or the column index is out of bounds. Throws an ArgumentError if columnIndex is negative.

```Dart
Future<int?> getColumnTypeOidByRelationIdAndColumnIndex({
  required int relationId,
  required int columnIndex,
}) async {
  if (columnIndex < 0) {
    throw ArgumentError('columnIndex must not be negative');
  }
  final m = _relationMessages[relationId];
  if (m == null) {
    return null;
  }
  if (columnIndex > m.columns.length) {
    return null;
  }
  return m.columns[columnIndex].typeOid;
}
```

--------------------------------

### Notification Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/Notification-class.html

Initializes a new Notification object with essential details from the PostgreSQL server.

```APIDOC
## Notification({required int processId, required String channel, required String payload})

### Description
Constructs a Notification object representing a notification received from a PostgreSQL server. It requires the process ID of the originating PostgreSQL process, the name of the channel the notification was sent on, and an optional payload containing data.

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **processId** (int) - Required - The PostgreSQL process ID from which the notification was generated.
* **channel** (String) - Required - The name of the channel that this notification occurred on.
* **payload** (String) - Required - An optional data payload accompanying this notification.
```

--------------------------------

### hashCode Implementation Example

Source: https://pub.dev/documentation/postgres/latest/postgres/Line/hashCode.html

This snippet demonstrates how to override the hashCode getter using Object.hash to combine the hash codes of multiple fields (a, b, c). Ensure that if operator == is overridden, hashCode is also overridden to maintain consistency for hash-based collections.

```dart
@override
int get hashCode => Object.hash(a, b, c);
```

--------------------------------

### DateRange Constructors

Source: https://pub.dev/documentation/postgres/latest/postgres/DateRange-class.html

Provides information on how to create instances of the DateRange class.

```APIDOC
## Constructors

### DateRange

```dart
DateRange(DateTime? lower, DateTime? upper, Bounds bounds)
```

### DateRange.empty

```dart
DateRange.empty()
```

Describes how to construct an empty DateRange.
```

--------------------------------

### BindMessage Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/messages/BindMessage/BindMessage.html

Shows the implementation of the BindMessage constructor, initializing its fields.

```dart
BindMessage(
  this._parameters, {
  String portalName = '',
  String statementName = '',
}) : _portalName = portalName,
     _statementName = statementName;

```

--------------------------------

### DateTimeRange Constructors

Source: https://pub.dev/documentation/postgres/latest/postgres/DateTimeRange-class.html

Provides information on how to create instances of the DateTimeRange class.

```APIDOC
## DateTimeRange Constructors

### DateTimeRange(DateTime? lower, DateTime? upper, Bounds bounds)

Creates a new DateTimeRange with specified lower and upper bounds and bounds type.

### DateTimeRange.empty()

Constructs an empty `TsRange`.
```

--------------------------------

### HotStandbyFeedbackMessage Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/HotStandbyFeedbackMessage-class.html

Constructs a HotStandbyFeedbackMessage with the client's time and various xmin values.

```APIDOC
## Constructors

### HotStandbyFeedbackMessage

**Parameters**

*   **clientTime** (DateTime) - The client's system clock at the time of transmission, as microseconds since midnight on 2000-01-01.
*   **currentGlobalXmin** (int) - The standby's current global xmin, excluding the catalog_xmin from any replication slots.
*   **epochGlobalXminXid** (int) - The epoch of the global xmin xid on the standby.
*   **lowestCatalogXmin** (int) - The lowest catalog_xmin of any replication slots on the standby.
*   **epochCatalogXminXid** (int) - The epoch of the catalog_xmin xid on the standby.
```

--------------------------------

### TransactionSettings Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/TransactionSettings/TransactionSettings.html

Initializes a new TransactionSettings object with specified transaction parameters.

```APIDOC
## TransactionSettings Constructor

### Description
Initializes a new TransactionSettings object with specified transaction parameters.

### Method
Constructor

### Parameters
#### Named Parameters
- **isolationLevel** (IsolationLevel?) - Optional - Specifies the transaction isolation level.
- **accessMode** (AccessMode?) - Optional - Specifies the transaction access mode.
- **deferrable** (DeferrableMode?) - Optional - Specifies if the transaction is deferrable.
- **connectTimeout** (Duration?) - Optional - Sets the connection timeout duration.
- **queryTimeout** (Duration?) - Optional - Sets the query timeout duration.
- **queryMode** (QueryMode?) - Optional - Specifies the query mode.
- **ignoreSuperfluousParameters** (bool?) - Optional - If true, ignores superfluous parameters.
```

--------------------------------

### Prepare Abstract Method Signature

Source: https://pub.dev/documentation/postgres/latest/postgres/Session/prepare.html

The signature for the `prepare` abstract method. It takes an Object representing the query and returns a Future that completes with a Statement.

```java
Future<Statement> prepare(
  Object query
)
```

--------------------------------

### PostgreSQL Time Constant Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Type/time-constant.html

Demonstrates the static initialization of a Time constant using GenericType in PostgreSQL.

```typescript
static const time = GenericType<Time>(TypeOid.time);
```

--------------------------------

### Create a new PgByteDataReader

Source: https://pub.dev/documentation/postgres/latest/postgres/CodecContext/newPgByteDataReader.html

Initializes a new PgByteDataReader with the current codec context. If bytes are provided, they are added to the reader.

```dart
PgByteDataReader newPgByteDataReader([Uint8List? bytes]) {
  final reader = PgByteDataReader(codecContext: this);
  if (bytes != null) {
    reader.add(bytes);
  }
  return reader;
}
```

--------------------------------

### Prepare Method Implementation Signature

Source: https://pub.dev/documentation/postgres/latest/postgres/Session/prepare.html

The implementation signature for the `prepare` abstract method, indicating the expected types for the query parameter.

```java
Future<Statement> prepare(Object /* String | Sql */ query);
```

--------------------------------

### JsonbListView Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/JsonbListView/JsonbListView.html

Initializes a new instance of the JsonbListView class.

```APIDOC
## JsonbListView(Iterable<Object?> items, List<bool> sqlNulls)

### Description
Constructs a JsonbListView with the provided items and SQL nullability information.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
1. **items** (Iterable<Object?>) - The iterable collection of items to be included in the view.
2. **sqlNulls** (List<bool>) - A list of booleans indicating the nullability of corresponding SQL values.

### Request Example
```dart
// Example usage (assuming context where JsonbListView is applicable)
// final listView = JsonbListView([1, 'test', null], [false, false, true]);
```

### Response
#### Success Response (200)
- N/A (This is a constructor)

#### Response Example
- N/A
```

--------------------------------

### Initialize LineSegment Constant

Source: https://pub.dev/documentation/postgres/latest/postgres/Type/lineSegment-constant.html

Demonstrates the static initialization of a LineSegment constant using GenericType.

```typescript
static const lineSegment = GenericType<LineSegment>(TypeOid.lineSegment);
```

--------------------------------

### BindCompleteMessage Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/messages/BindCompleteMessage/BindCompleteMessage.html

Shows the basic implementation of the BindCompleteMessage constructor.

```C++
BindCompleteMessage();
```

--------------------------------

### prepare Method

Source: https://pub.dev/documentation/postgres/latest/postgres/TxSession-class.html

Prepares a reusable SQL statement from a given query string. This method is inherited from the Session class.

```APIDOC
## prepare

### Description
Prepares a reusable statement from a `query`.

### Method
- **prepare**(Object query) → Future<Statement>
  - inherited
```

--------------------------------

### ResultStreamSubscription Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/ResultStreamSubscription/ResultStreamSubscription.html

Initializes a new instance of the ResultStreamSubscription class.

```APIDOC
## ResultStreamSubscription()

### Description
Initializes a new instance of the ResultStreamSubscription class.

### Method
constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
An instance of ResultStreamSubscription.

#### Response Example
None
```

--------------------------------

### JsonbListView Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/JsonbListView/JsonbListView.html

Shows the implementation of the JsonbListView constructor, initializing the superclass and the _sqlNulls field.

```dart
JsonbListView(super.items, List<bool> sqlNulls) : _sqlNulls = sqlNulls;
```

--------------------------------

### TransactionSettings Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/TransactionSettings-class.html

Initializes a new instance of the TransactionSettings class with specified transaction properties.

```APIDOC
## TransactionSettings Constructor

### Description
Initializes a new instance of the TransactionSettings class.

### Parameters
* **isolationLevel** (IsolationLevel?) - The isolation level of the transaction.
* **accessMode** (AccessMode?) - The transaction access mode (read-write or read-only).
* **deferrable** (DeferrableMode?) - Specifies if the transaction is deferrable.
* **connectTimeout** (Duration?) - The connection timeout duration.
* **queryTimeout** (Duration?) - The query timeout duration.
* **queryMode** (QueryMode?) - The query execution mode.
* **ignoreSuperfluousParameters** (bool?) - Whether to ignore superfluous parameters.
```

--------------------------------

### C++ Constant Execution

Source: https://pub.dev/documentation/postgres/latest/messages/ClientMessageId/execute-constant.html

Demonstrates the declaration and initialization of a static constant integer.

```cpp
static const int execute = 69;
```

--------------------------------

### withConnection<R>

Source: https://pub.dev/documentation/postgres/latest/postgres/Pool/withConnection.html

Acquires a connection from the pool, opening a new one if necessary, and calls the provided function `fn` with it. The connection should not be used after `fn` returns.

```APIDOC
## withConnection<R>

### Description
Acquires a connection from this pool, opening a new one if necessary, and calls `fn` with it. The connection must not be used after `fn` returns as it could be used by another withConnection call later.

### Method Signature
`Future<R> withConnection<R>(Future<R> fn(Connection connection), {ConnectionSettings? settings, L? locality})`

### Parameters
#### Function Parameter `fn`
- **connection** (Connection) - The connection object to be used within the function.

#### Optional Named Parameters
- **settings** (ConnectionSettings?) - Optional connection settings.
- **locality** (L?) - Optional locality parameter.
```

--------------------------------

### IntRange Constructors

Source: https://pub.dev/documentation/postgres/latest/postgres/IntRange-class.html

Provides methods to create instances of the IntRange class.

```APIDOC
## Constructors

### IntRange(int? lower, int? upper, Bounds bounds)

Creates a new IntRange with specified lower and upper bounds and boundary types.

### IntRange.empty()

Constructs an empty IntRange.
```

--------------------------------

### HotStandbyFeedbackMessage Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/HotStandbyFeedbackMessage/HotStandbyFeedbackMessage.html

Constructs a new HotStandbyFeedbackMessage object with the specified client time and Xmin values.

```APIDOC
## HotStandbyFeedbackMessage Constructor

### Description
Instantiates a HotStandbyFeedbackMessage with essential timing and Xmin information.

### Parameters
#### Constructor Parameters
- **clientTime** (DateTime) - The timestamp of the client.
- **currentGlobalXmin** (int) - The current global Xmin value.
- **epochGlobalXminXid** (int) - The Xmin ID for the global epoch.
- **lowestCatalogXmin** (int) - The lowest catalog Xmin value.
- **epochCatalogXminXid** (int) - The Xmin ID for the catalog epoch.

### Implementation
```dart
HotStandbyFeedbackMessage(
  this.clientTime,
  this.currentGlobalXmin,
  this.epochGlobalXminXid,
  this.lowestCatalogXmin,
  this.epochCatalogXminXid,
);
```
```

--------------------------------

### Pool.withUrl Constructor Implementation

Source: https://pub.dev/documentation/postgres/latest/postgres/Pool/Pool.withUrl.html

This snippet shows the implementation of the Pool.withUrl factory constructor. It parses a connection string to create a new pool with specified settings.

```dart
factory Pool.withUrl(String connectionString) {
  final parsed = parseConnectionString(
    connectionString,
    enablePoolSettings: true,
  );
  return PoolImplementation(
    roundRobinSelector(parsed.endpoints),
    PoolSettings(
      applicationName: parsed.applicationName,
      connectTimeout: parsed.connectTimeout,
      encoding: parsed.encoding,
      queryTimeout: parsed.queryTimeout,
      replicationMode: parsed.replicationMode,
      securityContext: parsed.securityContext,
      sslMode: parsed.sslMode,
      maxConnectionAge: parsed.maxConnectionAge,
      maxConnectionCount: parsed.maxConnectionCount,
      maxSessionUse: parsed.maxSessionUse,
      maxQueryCount: parsed.maxQueryCount,
    ),
  );
}
```

--------------------------------

### ConnectionSettings Constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/ConnectionSettings-class.html

Constructs a new ConnectionSettings object with various optional parameters to configure the database connection.

```APIDOC
## ConnectionSettings Constructor

### Description
Initializes a new instance of the ConnectionSettings class. This constructor allows for detailed configuration of various aspects of the PostgreSQL connection, such as application name, security settings, and connection timeouts.

### Parameters
- **applicationName** (String?): The name of the application connecting to the database.
- **timeZone** (String?): The time zone to use for the connection.
- **encoding** (Encoding?): The character encoding to use for the connection.
- **sslMode** (SslMode?): The SSL mode for the connection.
- **transformer** (StreamChannelTransformer<Message, Message>?): An optional transformer for the stream channel.
- **replicationMode** (ReplicationMode?): The replication mode for the connection.
- **typeRegistry** (TypeRegistry?): A custom type registry to use.
- **securityContext** (SecurityContext?): The security context for the connection.
- **onOpen** (Future<void> Function(Connection connection)?): A callback function executed after the connection is opened.
- **connectTimeout** (Duration?): The timeout duration for establishing a connection.
- **queryTimeout** (Duration?): The timeout duration for executing queries.
- **queryMode** (QueryMode?): The query execution mode.
- **ignoreSuperfluousParameters** (bool?): If true, superfluous parameters in queries will be ignored.
```

--------------------------------

### Line Class Constructors and Properties

Source: https://pub.dev/documentation/postgres/latest/postgres/Line-class.html

This snippet details the constructor and properties of the PostgreSQL Line class. The constructor initializes a line with coefficients a, b, and c. The properties 'a', 'b', and 'c' are final and represent these coefficients.

```APIDOC
## Line Class

Describes PostgreSQL's geometric type: `line`.
A line as defined by the linear equation _ax + by + c = 0_.

### Constructors

`Line(double a, double b, double c)`
Initializes a new instance of the Line class with the specified coefficients.

### Properties

- `a` → `double`
  The coefficient 'a' of the line equation. This property is final.
- `b` → `double`
  The coefficient 'b' of the line equation. This property is final.
- `c` → `double`
  The coefficient 'c' of the line equation. This property is final.
```

--------------------------------

### Path constructor

Source: https://pub.dev/documentation/postgres/latest/postgres/Path/Path.html

Constructs a Path object with a list of points and an open status.

```APIDOC
## Path constructor

### Description
Constructs a Path object with a list of points and an open status.

### Parameters
#### Path Parameters
- **points** (Iterable<Point>) - Required - A list of points defining the path.
- **open** (bool) - Required - Indicates if the path is open.

### Implementation
```dart
Path(super.points, {required this.open});
```
```

--------------------------------

### Time Constructors

Source: https://pub.dev/documentation/postgres/latest/postgres/Time-class.html

Provides documentation for the constructors of the Time class, used to create Time instances.

```APIDOC
## Constructors

### Time

```dart
Time([int hour = 0, int minute = 0, int second = 0, int millisecond = 0, int microsecond = 0])
```

Construct a Time instance with optional hour, minute, second, millisecond, and microsecond values.

### Time.fromMicroseconds

```dart
Time.fromMicroseconds(int microseconds)
```

Construct a Time instance from a total number of microseconds.
```

--------------------------------

### fromBinaryFlag static method

Source: https://pub.dev/documentation/postgres/latest/postgres/EncodingFormat/fromBinaryFlag.html

This static method constructs an EncodingFormat based on whether the input flag indicates a binary format.

```APIDOC
## fromBinaryFlag static method

### Description
Creates an `EncodingFormat` instance. If `isBinary` is true, it returns the binary format; otherwise, it returns the text format.

### Method
static

### Signature
EncodingFormat fromBinaryFlag(bool isBinary)

### Parameters
#### Path Parameters
- **isBinary** (bool) - Required - Indicates whether the format should be binary.
```

--------------------------------

### AuthenticationMessageType Constructor

Source: https://pub.dev/documentation/postgres/latest/messages/AuthenticationMessageType/AuthenticationMessageType.html

Initializes a new instance of the AuthenticationMessageType. No arguments are required.

```csharp
AuthenticationMessageType()
```
Tokens:
Raw