stac-duckdb 0.3.12

Client for querying stac-geoparquet using DuckDB
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

//! Use [duckdb](https://duckdb.org/) with [STAC](https://stacspec.org).

#![warn(unused_crate_dependencies)]

mod client;
mod error;
mod extension;

pub use {
    client::ArrowBatchReader, client::Client, client::HrefClient, client::SearchArrowBatchIter,
    client::SourceFormat, client::SyncHrefClient, error::Error, extension::Extension,
};

use getrandom as _;
#[cfg(test)]
use tokio_test as _;

/// Searches a stac-geoparquet file.
///
/// # Examples
///
/// ```
/// let item_collection = stac_duckdb::search("data/100-sentinel-2-items.parquet", Default::default(), None).unwrap();
/// ```
pub fn search(
    href: &str,
    mut search: stac::api::Search,
    max_items: Option<usize>,
) -> Result<stac::api::ItemCollection> {
    if let Some(max_items) = max_items {
        search.limit = Some(max_items.try_into()?);
    } else {
        search.limit = None;
    };
    let client = Client::new()?;
    client.search(href, search)
}

/// A crate-specific result type.
pub type Result<T> = std::result::Result<T, Error>;

/// Return this crate's version.
///
/// # Examples
///
/// ```
/// println!("{}", stac_duckdb::version());
/// ```
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}