holochain_data 0.7.0-rc.1

Database abstraction layer for Holochain using sqlx
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

//! `DbRead<Dht>` / `DbWrite<Dht>` API for the `ScheduledFunction` table.

use super::super::inner::scheduled_function::{self, InsertScheduledFunction};
use crate::handles::{DbRead, DbWrite};
use crate::kind::Dht;
use holo_hash::AgentPubKey;
use holochain_timestamp::Timestamp;

impl DbRead<Dht> {
    /// Fetch persisted (non-ephemeral) scheduled-function rows for `author` whose
    /// `end_at` is before `now`. Returns `(zome_name, scheduled_fn, maybe_schedule_blob)` tuples.
    pub async fn get_expired_persisted_scheduled_functions(
        &self,
        author: &AgentPubKey,
        now: Timestamp,
    ) -> sqlx::Result<Vec<(String, String, Vec<u8>)>> {
        let mut conn = self.timed_conn().await?;
        scheduled_function::get_expired_persisted_scheduled_functions(&mut *conn, author, now).await
    }

    /// Return live scheduled-function rows for `author` at `now`.
    ///
    /// A row is "live" when `start_at <= now AND now <= end_at`. Returns
    /// `(zome_name, scheduled_fn, maybe_schedule_blob, ephemeral)` tuples.
    pub async fn get_live_scheduled_functions(
        &self,
        author: &AgentPubKey,
        now: Timestamp,
    ) -> sqlx::Result<Vec<(String, String, Vec<u8>, bool)>> {
        let mut conn = self.timed_conn().await?;
        scheduled_function::get_live_scheduled_functions(&mut *conn, author, now).await
    }

    /// Return `true` if a scheduled-function row exists for the given
    /// `(author, zome_name, scheduled_fn)` tuple, regardless of liveness.
    pub async fn is_function_scheduled(
        &self,
        author: &AgentPubKey,
        zome_name: &str,
        scheduled_fn: &str,
    ) -> sqlx::Result<bool> {
        let mut conn = self.timed_conn().await?;
        scheduled_function::is_function_scheduled(&mut *conn, author, zome_name, scheduled_fn).await
    }
}

impl DbWrite<Dht> {
    /// Upsert a scheduled-function row. Returns the number of rows written.
    pub async fn upsert_scheduled_function(
        &self,
        f: InsertScheduledFunction<'_>,
    ) -> sqlx::Result<u64> {
        scheduled_function::upsert_scheduled_function(self.pool(), f).await
    }

    /// Delete the scheduled-function row for the given `(author, zome_name, scheduled_fn)` tuple.
    /// Returns the number of rows deleted.
    pub async fn delete_scheduled_function(
        &self,
        author: &AgentPubKey,
        zome_name: &str,
        scheduled_fn: &str,
    ) -> sqlx::Result<u64> {
        scheduled_function::delete_scheduled_function(self.pool(), author, zome_name, scheduled_fn)
            .await
    }

    /// Delete all live ephemeral scheduled-function rows for `author` whose
    /// `start_at` is at or before `now`. Returns the number of rows deleted.
    pub async fn delete_live_ephemeral_scheduled_functions(
        &self,
        author: &AgentPubKey,
        now: Timestamp,
    ) -> sqlx::Result<u64> {
        scheduled_function::delete_live_ephemeral_scheduled_functions(self.pool(), author, now)
            .await
    }

    /// Delete every ephemeral scheduled-function row, regardless of author or
    /// liveness. Returns the number of rows deleted.
    pub async fn delete_all_ephemeral_scheduled_functions(&self) -> sqlx::Result<u64> {
        scheduled_function::delete_all_ephemeral_scheduled_functions(self.pool()).await
    }
}