rust/neon
1
0
Fork 0
mirror of https://github.com/neondatabase/neon.git synced 2026-06-03 13:30:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve comments on TenantStates

Browse Source
This commit is contained in:
Heikki Linnakangas
2022-11-22 11:01:09 +02:00
committed by Heikki Linnakangas
parent 99d9c23df5
commit 5bca7713c1
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
libs/pageserver_api/src/models.rs
View File

@@ -17,10 +17,11 @@ use bytes::{BufMut, Bytes, BytesMut};
pub enum TenantState {
/// Tenant is fully operational, its background jobs might be running or not.
Active { background_jobs_running: bool },
/// A tenant is recognized by pageserver, but not yet ready to operate:
/// e.g. not present locally and being downloaded or being read into memory from the file system.
/// A tenant is recognized by pageserver, but it is being detached or the
/// system is being shut down.
Paused,
/// A tenant is recognized by the pageserver, but no longer used for any operations, as failed to get activated.
/// A tenant is recognized by the pageserver, but can no longer be used for
/// any operations, because it failed to be activated.
Broken,
}
@@ -36,7 +37,8 @@ pub enum TimelineState {
/// A timeline is recognized by pageserver, but not yet ready to operate and not allowed to
/// automatically become Active after certain events: only a management call can change this status.
Paused,
/// A timeline is recognized by the pageserver, but no longer used for any operations, as failed to get activated.
/// A timeline is recognized by the pageserver, but can no longer be used for
/// any operations, because it failed to be activated.
Broken,
}