atlas-rust 0.10.0

Directory-based store for thousands of N-dimensional datasets local or remote using object storage.
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use std::sync::Arc;

use atlas::{Atlas, Attr, DType, StatValue, StoreConfig};
use ndarray::ArrayD;
use object_store::{local::LocalFileSystem, path::Path};

fn make_store(tmp: &tempfile::TempDir) -> (Arc<dyn object_store::ObjectStore>, Path) {
    let store: Arc<dyn object_store::ObjectStore> = Arc::new(LocalFileSystem::new());
    let prefix = Path::from_absolute_path(tmp.path()).unwrap();
    (store, prefix)
}

#[tokio::test]
async fn create_write_read_roundtrip() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    let data = ArrayD::<f32>::from_elem(vec![4, 4], 42.0_f32);

    {
        let mut ds = atlas.create_dataset("ds_jan").await.unwrap();
        ds.define_array::<f32>(
            "temperature",
            vec!["lat".into(), "lon".into()],
            vec![4, 4],
            None,
            None,
        )
        .await
        .unwrap();
        ds.write_array("temperature", vec![0, 0], data.view()).await.unwrap();
        ds.set_attribute("month", Attr::Int64(1));
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    assert!(atlas2.dataset_exists("ds_jan"));

    let ds2 = atlas2.open_dataset("ds_jan").await.unwrap();
    let result = ds2
        .read_array::<f32>("temperature", vec![], vec![])
        .await
        .unwrap()
        .unwrap();
    assert_eq!(result, data.into_shared());
    assert_eq!(ds2.get_attribute("month"), Some(Attr::Int64(1)));
}

#[tokio::test]
async fn two_datasets_share_array_file() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    let data_jan = ArrayD::<f32>::from_elem(vec![2, 2], 1.0_f32);
    let data_feb = ArrayD::<f32>::from_elem(vec![2, 2], 2.0_f32);

    {
        let mut ds = atlas.create_dataset("ds_jan").await.unwrap();
        ds.define_array::<f32>("temp", vec!["x".into(), "y".into()], vec![2, 2], None, None)
            .await
            .unwrap();
        ds.write_array("temp", vec![0, 0], data_jan.view()).await.unwrap();
    }
    {
        let mut ds = atlas.create_dataset("ds_feb").await.unwrap();
        ds.define_array::<f32>("temp", vec!["x".into(), "y".into()], vec![2, 2], None, None)
            .await
            .unwrap();
        ds.write_array("temp", vec![0, 0], data_feb.view()).await.unwrap();
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let mut datasets = atlas2.list_datasets();
    datasets.sort();
    assert_eq!(datasets, vec!["ds_feb".to_string(), "ds_jan".to_string()]);

    let ds_jan = atlas2.open_dataset("ds_jan").await.unwrap();
    let ds_feb = atlas2.open_dataset("ds_feb").await.unwrap();

    let jan = ds_jan.read_array::<f32>("temp", vec![], vec![]).await.unwrap().unwrap();
    let feb = ds_feb.read_array::<f32>("temp", vec![], vec![]).await.unwrap().unwrap();

    assert_eq!(jan, data_jan.into_shared());
    assert_eq!(feb, data_feb.into_shared());
}

#[tokio::test]
async fn list_datasets_and_arrays() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    for name in &["a", "b", "c"] {
        let mut ds = atlas.create_dataset(name).await.unwrap();
        ds.define_array::<f32>("x", vec!["i".into()], vec![3], None, None)
            .await
            .unwrap();
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let mut names = atlas2.list_datasets();
    names.sort();
    assert_eq!(names, vec!["a".to_string(), "b".to_string(), "c".to_string()]);
    assert_eq!(atlas2.list_arrays(), vec!["x".to_string()]);
}

#[tokio::test]
async fn delete_dataset() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("to_delete").await.unwrap();
        ds.define_array::<f32>("arr", vec!["i".into()], vec![4], None, None)
            .await
            .unwrap();
    }
    atlas.flush().await.unwrap();

    assert!(atlas.dataset_exists("to_delete"));
    atlas.delete_dataset("to_delete").await.unwrap();
    atlas.flush().await.unwrap();
    assert!(!atlas.dataset_exists("to_delete"));

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    assert!(!atlas2.dataset_exists("to_delete"));
}

#[tokio::test]
async fn attributes_survive_reopen() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("meta_test").await.unwrap();
        ds.define_array::<f32>("v", vec!["t".into()], vec![2], None, None)
            .await
            .unwrap();
        ds.set_attribute("sensor", Attr::String("ABC".into()));
        ds.set_attribute("year", Attr::Int64(2023));
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let ds2 = atlas2.open_dataset("meta_test").await.unwrap();
    assert_eq!(ds2.get_attribute("sensor"), Some(Attr::String("ABC".into())));
    assert_eq!(ds2.get_attribute("year"), Some(Attr::Int64(2023)));
}

#[tokio::test]
async fn reject_invalid_names() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store, prefix, StoreConfig::default()).await.unwrap();

    assert!(atlas.create_dataset("").await.is_err());
    assert!(atlas.create_dataset("..").await.is_err());
    assert!(atlas.create_dataset("a/b").await.is_err());
    assert!(atlas.create_dataset("_hidden").await.is_err());
}

#[tokio::test]
async fn meta_survives_flush_and_reopen() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("meta_test").await.unwrap();
        ds.define_array::<f32>(
            "temp",
            vec!["lat".into(), "lon".into()],
            vec![4, 8],
            Some(vec![2, 4]),
            None,
        )
        .await
        .unwrap();
        ds.define_array::<i64>("time", vec!["t".into()], vec![100], None, None)
            .await
            .unwrap();
        ds.set_attribute("year", Attr::Int64(2024));
        ds.set_attribute("active", Attr::Bool(true));
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let ds2 = atlas2.open_dataset("meta_test").await.unwrap();
    let meta = ds2.meta();

    let temp_schema = meta.arrays.get("temp").expect("temp array schema missing");
    assert_eq!(temp_schema.dtype, DType::Float32);
    assert_eq!(temp_schema.shape, vec![4, 8]);
    assert_eq!(temp_schema.chunk_shape, vec![2, 4]);
    assert_eq!(temp_schema.dimension_names, vec!["lat", "lon"]);

    let time_schema = meta.arrays.get("time").expect("time array schema missing");
    assert_eq!(time_schema.dtype, DType::Int64);
    assert_eq!(time_schema.shape, vec![100]);
    assert_eq!(time_schema.chunk_shape, vec![100]);

    assert_eq!(meta.attributes.get("year"), Some(&Attr::Int64(2024)));
    assert_eq!(meta.attributes.get("active"), Some(&Attr::Bool(true)));
}

#[tokio::test]
async fn atlas_no_implicit_flush() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("a").await.unwrap();
        ds.define_array::<f32>("arr", vec!["x".into()], vec![2], None, None).await.unwrap();
        ds.write_array("arr", vec![0], ndarray::arr1(&[1.0f32, 2.0]).into_dyn().view())
            .await
            .unwrap();
        // No flush — drop atlas-side handle but DO NOT call atlas.flush.
    }

    // A fresh Atlas opened on the same store sees nothing — atlas.json was never written.
    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    assert!(atlas2.list_datasets().is_empty());
}

#[tokio::test]
async fn atlas_flush_persists_meta_and_data() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds_a = atlas.create_dataset("a").await.unwrap();
        ds_a.define_array::<f32>("temp", vec!["x".into()], vec![4], None, None).await.unwrap();
        ds_a.write_array("temp", vec![0], ndarray::arr1(&[1.0f32, 2.0, 3.0, 4.0]).into_dyn().view())
            .await
            .unwrap();
    }
    {
        let mut ds_b = atlas.create_dataset("b").await.unwrap();
        ds_b.define_array::<f32>("temp", vec!["x".into()], vec![4], None, None).await.unwrap();
        ds_b.write_array("temp", vec![0], ndarray::arr1(&[5.0f32, 6.0, 7.0, 8.0]).into_dyn().view())
            .await
            .unwrap();
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let mut names = atlas2.list_datasets();
    names.sort();
    assert_eq!(names, vec!["a".to_string(), "b".to_string()]);
    let a = atlas2.open_dataset("a").await.unwrap();
    let b = atlas2.open_dataset("b").await.unwrap();
    let a_data = a.read_array::<f32>("temp", vec![], vec![]).await.unwrap().unwrap();
    let b_data = b.read_array::<f32>("temp", vec![], vec![]).await.unwrap().unwrap();
    assert_eq!(a_data.as_slice().unwrap(), &[1.0f32, 2.0, 3.0, 4.0]);
    assert_eq!(b_data.as_slice().unwrap(), &[5.0f32, 6.0, 7.0, 8.0]);
}

#[tokio::test]
async fn define_array_zero_dimensional_roundtrip() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("scalars").await.unwrap();
        ds.define_array::<f32>("answer", vec![], vec![], None, None).await.unwrap();
        let data = ndarray::Array0::from_elem((), 42.0_f32).into_dyn();
        ds.write_array("answer", vec![], data.view()).await.unwrap();
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let ds2 = atlas2.open_dataset("scalars").await.unwrap();
    let schema = ds2.meta();
    let answer = schema.arrays.get("answer").unwrap();
    assert_eq!(answer.shape, Vec::<usize>::new());
    assert_eq!(answer.dimension_names, Vec::<String>::new());

    let read = ds2.read_array::<f32>("answer", vec![], vec![]).await.unwrap().unwrap();
    assert_eq!(read.ndim(), 0);
    assert_eq!(read[ndarray::IxDyn(&[])], 42.0);
}

#[tokio::test]
async fn timestamp_ns_array_and_attr_survive_flush_and_reopen() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("ts").await.unwrap();
        ds.define_array::<atlas::TimestampNs>(
            "event_time",
            vec!["t".into()],
            vec![3],
            None,
            None,
        )
        .await
        .unwrap();

        let data = ndarray::arr1(&[
            atlas::TimestampNs(1_700_000_000_000_000_000),
            atlas::TimestampNs(1_700_000_000_000_000_001),
            atlas::TimestampNs(1_700_000_000_000_000_002),
        ])
        .into_dyn();
        ds.write_array("event_time", vec![0], data.view()).await.unwrap();
        ds.set_attribute("created_at", Attr::TimestampNanoseconds(1_700_000_000_000_000_000));
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let ds2 = atlas2.open_dataset("ts").await.unwrap();

    let meta = ds2.meta();
    let schema = meta.arrays.get("event_time").unwrap();
    assert_eq!(schema.dtype, DType::TimestampNs);

    let read = ds2
        .read_array::<atlas::TimestampNs>("event_time", vec![], vec![])
        .await
        .unwrap()
        .unwrap();
    assert_eq!(read[0].0, 1_700_000_000_000_000_000);
    assert_eq!(read[2].0, 1_700_000_000_000_000_002);

    assert_eq!(
        meta.attributes.get("created_at"),
        Some(&Attr::TimestampNanoseconds(1_700_000_000_000_000_000)),
    );
}

#[tokio::test]
async fn array_stats_after_flush() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store, prefix, StoreConfig::default()).await.unwrap();

    let mut ds = atlas.create_dataset("stats_test").await.unwrap();

    ds.define_array::<f32>("temp", vec!["x".into()], vec![4], None, None)
        .await
        .unwrap();
    let data = ndarray::arr1(&[10.0_f32, 20.0, 5.0, 15.0]).into_dyn();
    ds.write_array("temp", vec![0], data.view()).await.unwrap();

    ds.define_array::<i64>("time", vec!["t".into()], vec![3], None, None)
        .await
        .unwrap();
    let times = ndarray::arr1(&[100_i64, 200, 300]).into_dyn();
    ds.write_array("time", vec![0], times.view()).await.unwrap();

    // Stats are None before flush
    assert!(ds.array_stats("temp").await.is_none());

    // Drop the borrow so we can call atlas.flush.
    drop(ds);
    atlas.flush().await.unwrap();

    // Reopen to verify stats persisted.
    let ds_reopened = atlas.open_dataset("stats_test").await.unwrap();
    let temp_stats = ds_reopened.array_stats("temp").await.unwrap();
    assert_eq!(temp_stats.row_count, 4);
    assert_eq!(temp_stats.null_count, 0);
    assert_eq!(temp_stats.min, Some(StatValue::Float(5.0)));
    assert_eq!(temp_stats.max, Some(StatValue::Float(20.0)));

    let time_stats = ds_reopened.array_stats("time").await.unwrap();
    assert_eq!(time_stats.row_count, 3);
    assert_eq!(time_stats.min, Some(StatValue::Int(100)));
    assert_eq!(time_stats.max, Some(StatValue::Int(300)));
}

#[tokio::test]
async fn array_stats_survive_reopen() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store.clone(), prefix.clone(), StoreConfig::default()).await.unwrap();

    {
        let mut ds = atlas.create_dataset("ds").await.unwrap();
        ds.define_array::<f64>("values", vec!["i".into()], vec![5], None, None)
            .await
            .unwrap();
        let data = ndarray::arr1(&[3.0_f64, 1.0, 4.0, 1.5, 9.0]).into_dyn();
        ds.write_array("values", vec![0], data.view()).await.unwrap();
    }
    atlas.flush().await.unwrap();

    let atlas2 = Atlas::open(store, prefix).await.unwrap();
    let ds2 = atlas2.open_dataset("ds").await.unwrap();
    let stats = ds2.array_stats("values").await.unwrap();
    assert_eq!(stats.row_count, 5);
    assert_eq!(stats.min, Some(StatValue::Float(1.0)));
    assert_eq!(stats.max, Some(StatValue::Float(9.0)));
}

#[tokio::test]
async fn array_stats_unknown_array_returns_none() {
    let tmp = tempfile::tempdir().unwrap();
    let (store, prefix) = make_store(&tmp);
    let mut atlas = Atlas::create(store, prefix, StoreConfig::default()).await.unwrap();
    let ds = atlas.create_dataset("ds").await.unwrap();
    assert!(ds.array_stats("ghost").await.is_none());
}