stac-server 0.5.2

SpatioTemporal Asset Catalog (STAC) API server
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use super::Backend;
use crate::{Error, Result};
use bb8::{ManageConnection, Pool};
use futures_core::Stream;
use stac::Collection;
use stac::api::{
    CollectionsClient, ItemsClient, Search, StreamItemsClient, TransactionClient, stream_pages,
};
use stac_duckdb::Client;

/// A backend that uses [DuckDB](https://duckdb.org/) to query
/// [stac-geoparquet](https://github.com/stac-utils/stac-geoparquet).
#[derive(Clone, Debug)]
pub struct DuckdbBackend {
    pool: Pool<DuckdbConnectionManager>,
}

struct DuckdbConnectionManager {
    href: String,
}

struct DuckdbConnection {
    client: Client,
    href: String,
}

impl DuckdbBackend {
    /// Creates a new DuckDB backend pointing to a single **stac-geoparquet** file.
    ///
    /// # Examples
    ///
    /// ```
    /// use stac_server::DuckdbBackend;
    /// # tokio_test::block_on(async {
    /// let backend = DuckdbBackend::new("data/100-sentinel-2-items.parquet").await.unwrap();
    /// # })
    /// ```
    pub async fn new(href: impl ToString) -> Result<DuckdbBackend> {
        let pool = Pool::builder()
            .build(DuckdbConnectionManager {
                href: href.to_string(),
            })
            .await?;
        Ok(DuckdbBackend { pool })
    }
}

impl ItemsClient for DuckdbBackend {
    type Error = Error;

    async fn search(&self, search: Search) -> Result<stac::api::ItemCollection> {
        let client = self.pool.get().await.map_err(Box::new)?;
        client.search(search)
    }
}

impl CollectionsClient for DuckdbBackend {
    type Error = Error;

    async fn collections(&self) -> Result<Vec<Collection>> {
        let client = self.pool.get().await.map_err(Box::new)?;
        client.collections()
    }

    async fn collection(&self, id: &str) -> Result<Option<Collection>> {
        let client = self.pool.get().await.map_err(Box::new)?;
        client.collection(id)
    }
}

impl TransactionClient for DuckdbBackend {
    type Error = Error;

    async fn add_collection(&mut self, _collection: Collection) -> Result<()> {
        Err(Error::ReadOnly)
    }

    async fn add_item(&mut self, _item: stac::Item) -> Result<()> {
        Err(Error::ReadOnly)
    }
}

impl StreamItemsClient for DuckdbBackend {
    type Error = Error;

    async fn search_stream(
        &self,
        search: Search,
    ) -> Result<impl Stream<Item = std::result::Result<stac::api::Item, Error>> + Send> {
        let page = ItemsClient::search(self, search.clone()).await?;
        Ok(stream_pages(self.clone(), search, page))
    }
}

impl Backend for DuckdbBackend {
    fn has_item_search(&self) -> bool {
        true
    }

    fn has_filter(&self) -> bool {
        false
    }
}

impl ManageConnection for DuckdbConnectionManager {
    type Connection = DuckdbConnection;
    type Error = Error;

    async fn connect(&self) -> Result<DuckdbConnection> {
        DuckdbConnection::new(&self.href)
    }

    async fn is_valid(&self, _conn: &mut DuckdbConnection) -> Result<()> {
        Ok(())
    }

    fn has_broken(&self, _conn: &mut DuckdbConnection) -> bool {
        false
    }
}

impl DuckdbConnection {
    fn new(href: impl ToString) -> Result<DuckdbConnection> {
        let client = Client::new()?;
        Ok(DuckdbConnection {
            client,
            href: href.to_string(),
        })
    }

    fn collections(&self) -> Result<Vec<Collection>> {
        let collections = self.client.collections(&self.href)?;
        Ok(collections)
    }

    fn collection(&self, id: &str) -> Result<Option<Collection>> {
        let collections = self.client.collections(&self.href)?;
        Ok(collections
            .into_iter()
            .find(|collection| collection.id == id))
    }

    fn search(&self, search: Search) -> Result<stac::api::ItemCollection> {
        let item_collection = self.client.search(&self.href, search)?;
        Ok(item_collection)
    }
}

#[cfg(test)]
mod tests {
    use stac::api::CollectionsClient;

    #[tokio::test]
    async fn backend() {
        let backend = super::DuckdbBackend::new("data/100-sentinel-2-items.parquet")
            .await
            .unwrap();
        assert!(
            backend
                .collection("sentinel-2-l2a")
                .await
                .unwrap()
                .is_some()
        );
    }
}