endjine 0.0.5

Accessing the Engine DJ library database.
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

// SPDX-FileCopyrightText: The endjine authors
// SPDX-License-Identifier: MPL-2.0

use futures_util::stream::BoxStream;
use sqlx::{FromRow, SqliteExecutor};

use crate::TrackId;

crate::db_id!(PreparelistEntityId);

/// Item in the _Preparelist_.
///
/// The terminology used in the schema is confusing.
#[derive(Debug, Clone, FromRow)]
#[sqlx(rename_all = "camelCase")]
pub struct PreparelistEntity {
    pub id: PreparelistEntityId,
    pub track_id: TrackId,
    pub track_number: i64,
}

impl PreparelistEntity {
    /// Checks if the table is available in the database.
    pub async fn is_available<'a>(executor: impl SqliteExecutor<'a> + 'a) -> sqlx::Result<bool> {
        let (exists,) = sqlx::query_as(
            r"SELECT EXISTS(SELECT 1 FROM sqlite_master WHERE type='table' AND name='PreparelistEntity')",
        )
        .fetch_one(executor)
        .await?;
        Ok(exists)
    }

    /// Fetches all [`PreparelistEntity`]s asynchronously.
    ///
    /// Unfiltered and in no particular order.
    #[must_use]
    pub fn fetch_all<'a>(
        executor: impl SqliteExecutor<'a> + 'a,
    ) -> BoxStream<'a, sqlx::Result<Self>> {
        sqlx::query_as(r"SELECT * FROM PreparelistEntity").fetch(executor)
    }

    /// Loads a single [`PreparelistEntity`] by ID.
    ///
    /// Returns `Ok(None)` if the requested [`PreparelistEntity`] has not been found.
    pub async fn try_load(
        executor: impl SqliteExecutor<'_>,
        id: PreparelistEntityId,
    ) -> sqlx::Result<Option<Self>> {
        sqlx::query_as(r"SELECT * FROM PreparelistEntity WHERE id=?1")
            .bind(id)
            .fetch_optional(executor)
            .await
    }
}