Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 8 additions & 10 deletions src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -737,11 +737,10 @@ impl NodeBuilder {
///
/// # Warning
///
/// Do not point multiple [`Node`] instances at the same database and table. Concurrent access is
/// unsafe and can corrupt node state. You must make sure that only one node accesses each
/// database and table. The store uses a PostgreSQL advisory lock to reduce this risk. This lock
/// is only a temporary safeguard and does not make concurrent access safe.
/// Nodes using a different database or table on the same server may coexist.
/// This acquires an exclusive lease for the selected KV table before reading persisted node
/// state. Nodes may share a database when each node identity uses a distinct `kv_table_name`.
/// Mutations panic on detected lease loss. Failed or timed-out renewals panic in the background
/// renewal task. Node recovery is not handled automatically.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to mention it's not handled automatically, but should we at least give the user half a sentence of guidance what this effectively means, i.e., what they are supposed to do if it panics?

///
/// If `certificate_pem` is `Some`, TLS will be used for database connections and the
/// provided PEM-encoded CA certificate will be added to the system's default root
Expand Down Expand Up @@ -1334,11 +1333,10 @@ impl Builder {
///
/// # Warning
///
/// Do not point multiple [`Node`] instances at the same database and table. Concurrent access is
/// unsafe and can corrupt node state. You must make sure that only one node accesses each
/// database and table. The store uses a PostgreSQL advisory lock to reduce this risk. This lock
/// is only a temporary safeguard and does not make concurrent access safe.
/// Nodes using a different database or table on the same server may coexist.
/// This acquires an exclusive lease for the selected KV table before reading persisted node
/// state. Nodes may share a database when each node identity uses a distinct `kv_table_name`.
/// Mutations panic on detected lease loss. Failed or timed-out renewals panic in the background
/// renewal task. Node recovery is not handled automatically.
///
/// If `certificate_pem` is `Some`, TLS will be used for database connections and the
/// provided PEM-encoded CA certificate will be added to the system's default root
Expand Down
Loading
Loading