Skip to content

feat: add replication mode flag (v3) #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2023
Merged

feat: add replication mode flag (v3) #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions lib/postgres_v3_experimental.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import 'dart:async';
import 'dart:io';

import 'package:collection/collection.dart';
import 'package:postgres/src/replication.dart';
import 'package:stream_channel/stream_channel.dart';

import 'src/v3/connection.dart';
Expand Down Expand Up @@ -359,11 +360,26 @@ final class PgSessionSettings {
/// For an example, see `example/v3/transformer.dart`.
final StreamChannelTransformer<BaseMessage, BaseMessage>? transformer;

/// The replication mode for connecting in streaming replication mode.
///
/// The default value is [ReplicationMode.none]. But when the value is set to
/// [ReplicationMode.physical] or [ReplicationMode.logical], the connection
/// will be established in replication mode.
///
/// Please note, while in replication mode, only the Simple Query Protcol can
/// be used to execute queries.
///
/// For more info, see [Streaming Replication Protocol]
///
/// [Streaming Replication Protocol]: https://www.postgresql.org/docs/current/protocol-replication.html
final ReplicationMode replicationMode;

PgSessionSettings({
this.connectTimeout,
this.timeZone,
this.onBadSslCertificate,
this.transformer,
this.replicationMode = ReplicationMode.none
});
}

Expand Down
8 changes: 6 additions & 2 deletions lib/src/v3/connection.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import 'package:collection/collection.dart';
import 'package:pool/pool.dart';
import 'package:postgres/postgres_v3_experimental.dart';
import 'package:postgres/src/query.dart';
import 'package:postgres/src/replication.dart';
import 'package:stream_channel/stream_channel.dart';

import '../auth/auth.dart';
Expand Down Expand Up @@ -37,6 +38,8 @@ class _ResolvedSettings {
final String timeZone;
//final Encoding encoding;

final ReplicationMode replicationMode;

final StreamChannelTransformer<BaseMessage, BaseMessage>? transformer;

_ResolvedSettings(
Expand All @@ -49,7 +52,8 @@ class _ResolvedSettings {
//queryTimeout = settings?.connectTimeout ?? const Duration(minutes: 5),
timeZone = settings?.timeZone ?? 'UTC',
// encoding = settings?.encoding ?? utf8,
transformer = settings?.transformer;
transformer = settings?.transformer,
replicationMode = settings?.replicationMode ?? ReplicationMode.none;

bool onBadSslCertificate(X509Certificate certificate) {
return settings?.onBadSslCertificate?.call(certificate) ?? false;
Expand Down Expand Up @@ -304,7 +308,7 @@ class PgConnectionImplementation extends _PgSessionBase
_settings.endpoint.database,
_settings.timeZone,
username: _settings.username,
// todo: Replication
replication: _settings.replicationMode,
));

return result._done.future;
Expand Down