nodedb 0.4.0

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

// SPDX-License-Identifier: BUSL-1.1

//! Protocol-neutral `ALTER RETENTION POLICY` DDL handler.
//!
//! Ported from the pgwire `ddl::retention_policy::alter` handler. The registry
//! load, the ENABLE / DISABLE / SET (AUTO_TIER, EVAL_INTERVAL) mutations, the
//! direct catalog write (`put_retention_policy`), the in-memory registry update,
//! and the audit record are preserved verbatim; only the result construction
//! changed from pgwire `Response` / `PgWireError` to the protocol-neutral
//! [`DdlResult`] / [`DdlError`].
//!
//! Syntax:
//! ```sql
//! ALTER RETENTION POLICY <name> ON <collection> ENABLE | DISABLE
//! ALTER RETENTION POLICY <name> ON <collection> SET AUTO_TIER = TRUE | FALSE
//! ALTER RETENTION POLICY <name> ON <collection> SET EVAL_INTERVAL = '<duration>'
//! ```

use nodedb_types::DatabaseId;

use crate::control::security::identity::AuthenticatedIdentity;
use crate::control::state::SharedState;

use super::super::super::result::{DdlError, DdlResult};
use super::super::auth_support::require_tenant_admin;

fn err(sqlstate: &str, message: String) -> DdlError {
    DdlError {
        sqlstate: sqlstate.to_string(),
        message,
    }
}

/// Handle `ALTER RETENTION POLICY <name> ENABLE | DISABLE | SET <key> = <value>`.
///
/// `name`, `action`, `set_key`, and `set_value` come from the typed
/// [`PolicyStmt::AlterRetentionPolicy`] variant. `database_id` scopes
/// the in-memory registry lookup to the session's database.
pub fn alter_retention_policy(
    state: &SharedState,
    identity: &AuthenticatedIdentity,
    database_id: DatabaseId,
    name: &str,
    action: &str,
    set_key: Option<&str>,
    set_value: Option<&str>,
) -> Result<Vec<DdlResult>, DdlError> {
    require_tenant_admin(identity, "alter retention policies")?;

    let tenant_id = identity.tenant_id.as_u64();

    // Load existing policy.
    let mut def = state
        .retention_policy_registry
        .get(database_id.as_u64(), tenant_id, name)
        .ok_or_else(|| err("42704", format!("retention policy '{name}' does not exist")))?;

    match action {
        "ENABLE" => def.enabled = true,
        "DISABLE" => def.enabled = false,
        "SET" => {
            let key = set_key.unwrap_or("");
            let val = set_value.unwrap_or("");
            match key {
                "AUTO_TIER" => {
                    def.auto_tier = val.eq_ignore_ascii_case("TRUE");
                }
                "EVAL_INTERVAL" => {
                    let ms = nodedb_types::kv_parsing::parse_interval_to_ms(val)
                        .map_err(|e| err("42601", format!("invalid interval: {e}")))?;
                    def.eval_interval_ms = ms;
                }
                _ => {
                    return Err(err(
                        "42601",
                        "ALTER RETENTION POLICY SET supports: AUTO_TIER, EVAL_INTERVAL".to_string(),
                    ));
                }
            }
        }
        _ => {
            return Err(err("42601", "expected ENABLE, DISABLE, or SET".to_string()));
        }
    }

    // Persist updated policy.
    let catalog = state.credentials.catalog();

    catalog
        .put_retention_policy(&def)
        .map_err(|e| err("XX000", format!("catalog write: {e}")))?;

    // Update in-memory registry.
    state.retention_policy_registry.register(def);

    state.audit_record(
        crate::control::security::audit::AuditEvent::AdminAction,
        Some(identity.tenant_id),
        &identity.username,
        &format!("ALTER RETENTION POLICY {name}"),
    );

    Ok(vec![DdlResult::Status {
        command: "ALTER RETENTION POLICY".to_string(),
        rows_affected: None,
    }])
}