bigtable_rs 0.3.0

A very simple Google Bigtable client lib in Rust
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
//! Integration tests that require a running Bigtable emulator.
//!
//! These tests are ignored by default and require:
//! 1. A running Bigtable emulator: `gcloud beta emulators bigtable start --host-port=localhost:8086`
//! 2. The BIGTABLE_EMULATOR_HOST environment variable set: `export BIGTABLE_EMULATOR_HOST=localhost:8086`
//! 3. A test table created with column families cf1 and cf2
//!
//! Run with: `BIGTABLE_EMULATOR_HOST=localhost:8086 cargo test --test tests emulator --features integration_tests`

#![cfg(feature = "integration_tests")]

use std::collections::HashMap;
use std::time::Duration;

use bigtable_rs::bigtable::{BigTableConnection, Error};
use futures_util::TryStreamExt;
use googleapis_tonic_google_bigtable_admin_v2::google::bigtable::admin::v2::{
    bigtable_table_admin_client::BigtableTableAdminClient, // This is the raw tonic client
    ColumnFamily,
    CreateTableRequest,
    Table,
};
use googleapis_tonic_google_bigtable_v2::google::bigtable::v2::mutation;
use googleapis_tonic_google_bigtable_v2::google::bigtable::v2::mutation::SetCell;
use googleapis_tonic_google_bigtable_v2::google::bigtable::v2::row_filter::{Chain, Filter};
use googleapis_tonic_google_bigtable_v2::google::bigtable::v2::row_range::{EndKey, StartKey};
use googleapis_tonic_google_bigtable_v2::google::bigtable::v2::{
    MutateRowRequest, Mutation, ReadRowsRequest, RowFilter, RowRange, RowSet, SampleRowKeysRequest,
};
use tokio::sync::OnceCell;
use tonic::transport::Channel;

const PROJECT_ID: &str = "project-1";
const INSTANCE_NAME: &str = "instance-1";
const TABLE_NAME: &str = "table-1";
const CF1: &str = "cf1";
const CF2: &str = "cf2";
const CHANNEL_SIZE: usize = 4;
const TIMEOUT_SECS: u64 = 10;

static INIT: OnceCell<()> = OnceCell::const_new();

async fn global_setup() {
    INIT.get_or_init(|| async {
        // 1. Connect to the emulator
        // Note: Emulator doesn't use TLS, so we use a plain channel
        let emulator_host = std::env::var("BIGTABLE_EMULATOR_HOST")
            .expect("BIGTABLE_EMULATOR_HOST must be set to run this test");
        let endpoint = format!("http://{}", emulator_host);

        let channel = Channel::from_shared(endpoint)
            .expect("Creating channel failed.")
            .connect()
            .await
            .expect("Connect to Bigtable emulater failed.");

        let mut client = BigtableTableAdminClient::new(channel);

        let mut column_families = HashMap::new();
        column_families.insert(CF1.to_string(), ColumnFamily::default());
        column_families.insert(CF2.to_string(), ColumnFamily::default());

        let request = CreateTableRequest {
            parent: format!("projects/{}/instances/{}", PROJECT_ID, INSTANCE_NAME),
            table_id: TABLE_NAME.to_string(),
            table: Some(Table {
                column_families,
                ..Default::default()
            }),
            initial_splits: vec![],
        };

        match client.create_table(request).await {
            Ok(_) => println!("Successfully created table: {}", TABLE_NAME),
            Err(e) if e.to_string().contains("already exists") => {
                println!("Table {} already exists in emulator, skipping.", TABLE_NAME);
            }
            Err(e) => panic!("Creating Bigtable table field. {}", e),
        };
    })
    .await;
}

async fn create_connection(read_only: bool) -> Result<BigTableConnection, Error> {
    BigTableConnection::new(
        PROJECT_ID,
        INSTANCE_NAME,
        read_only,
        CHANNEL_SIZE,
        Some(Duration::from_secs(TIMEOUT_SECS)),
    )
    .await
}

#[tokio::test]
async fn test_connection_to_emulator() {
    global_setup().await;

    let connection: Result<BigTableConnection, Error> = create_connection(true).await;
    assert!(connection.is_ok(), "Failed to connect to emulator");
}

#[tokio::test]
async fn test_write_and_read_row() {
    global_setup().await;

    let connection: BigTableConnection = create_connection(false).await.expect("Failed to connect");
    let mut bigtable = connection.client();

    let test_key = format!("integration_test_key_{}", std::process::id());
    let test_value = "integration_test_value";

    // Write a row
    let write_request = MutateRowRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        row_key: test_key.clone().into_bytes(),
        mutations: vec![Mutation {
            mutation: Some(mutation::Mutation::SetCell(SetCell {
                family_name: "cf1".to_owned(),
                column_qualifier: "c1".to_owned().into_bytes(),
                timestamp_micros: -1,
                value: test_value.to_owned().into_bytes(),
            })),
        }],
        ..MutateRowRequest::default()
    };

    let write_result = bigtable.mutate_row(write_request).await;
    assert!(
        write_result.is_ok(),
        "Failed to write row: {:?}",
        write_result.err()
    );

    // Read the row back
    let read_request = ReadRowsRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        rows_limit: 1,
        rows: Some(RowSet {
            row_keys: vec![test_key.clone().into_bytes()],
            row_ranges: vec![],
        }),
        filter: Some(RowFilter {
            filter: Some(Filter::CellsPerColumnLimitFilter(1)),
        }),
        ..ReadRowsRequest::default()
    };

    let response = bigtable.read_rows(read_request).await;
    assert!(response.is_ok(), "Failed to read row: {:?}", response.err());

    let rows = response.unwrap();
    assert_eq!(rows.len(), 1, "Expected 1 row, got {}", rows.len());

    let (key, cells) = &rows[0];
    assert_eq!(
        String::from_utf8(key.clone()).unwrap(),
        test_key,
        "Row key mismatch"
    );
    assert!(!cells.is_empty(), "Expected at least one cell");

    let cell = &cells[0];
    assert_eq!(cell.family_name, "cf1");
    assert_eq!(String::from_utf8(cell.qualifier.clone()).unwrap(), "c1");
    assert_eq!(String::from_utf8(cell.value.clone()).unwrap(), test_value);
}

#[tokio::test]
async fn test_read_rows_with_range() {
    global_setup().await;

    let connection: BigTableConnection = create_connection(false).await.expect("Failed to connect");
    let mut bigtable = connection.client();

    let prefix = format!("range_test_{}_", std::process::id());

    // Write multiple rows
    for i in 1..=5 {
        let key = format!("{}{}", prefix, i);
        let write_request = MutateRowRequest {
            table_name: bigtable.get_full_table_name(TABLE_NAME),
            row_key: key.into_bytes(),
            mutations: vec![Mutation {
                mutation: Some(mutation::Mutation::SetCell(SetCell {
                    family_name: "cf1".to_owned(),
                    column_qualifier: "c1".to_owned().into_bytes(),
                    timestamp_micros: -1,
                    value: format!("value{}", i).into_bytes(),
                })),
            }],
            ..MutateRowRequest::default()
        };
        bigtable
            .mutate_row(write_request)
            .await
            .expect("Failed to write row");
    }

    // Read with range (keys 1-3)
    let read_request = ReadRowsRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        rows_limit: 10,
        rows: Some(RowSet {
            row_keys: vec![],
            row_ranges: vec![RowRange {
                start_key: Some(StartKey::StartKeyClosed(
                    format!("{}1", prefix).into_bytes(),
                )),
                end_key: Some(EndKey::EndKeyOpen(format!("{}4", prefix).into_bytes())),
            }],
        }),
        filter: Some(RowFilter {
            filter: Some(Filter::CellsPerColumnLimitFilter(1)),
        }),
        ..ReadRowsRequest::default()
    };

    let response = bigtable.read_rows(read_request).await;
    assert!(
        response.is_ok(),
        "Failed to read rows: {:?}",
        response.err()
    );

    let rows = response.unwrap();
    assert_eq!(
        rows.len(),
        3,
        "Expected 3 rows in range, got {}",
        rows.len()
    );
}

#[tokio::test]
async fn test_read_rows_with_filter_chain() {
    global_setup().await;

    let connection: BigTableConnection = create_connection(false).await.expect("Failed to connect");
    let mut bigtable = connection.client();

    let test_key = format!("filter_test_{}", std::process::id());

    // Write a row with multiple column families and qualifiers
    let mutations = vec![
        Mutation {
            mutation: Some(mutation::Mutation::SetCell(SetCell {
                family_name: "cf1".to_owned(),
                column_qualifier: "c1".to_owned().into_bytes(),
                timestamp_micros: -1,
                value: "cf1_c1_value".to_owned().into_bytes(),
            })),
        },
        Mutation {
            mutation: Some(mutation::Mutation::SetCell(SetCell {
                family_name: "cf1".to_owned(),
                column_qualifier: "c2".to_owned().into_bytes(),
                timestamp_micros: -1,
                value: "cf1_c2_value".to_owned().into_bytes(),
            })),
        },
        Mutation {
            mutation: Some(mutation::Mutation::SetCell(SetCell {
                family_name: "cf2".to_owned(),
                column_qualifier: "c1".to_owned().into_bytes(),
                timestamp_micros: -1,
                value: "cf2_c1_value".to_owned().into_bytes(),
            })),
        },
    ];

    let write_request = MutateRowRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        row_key: test_key.clone().into_bytes(),
        mutations,
        ..MutateRowRequest::default()
    };

    bigtable
        .mutate_row(write_request)
        .await
        .expect("Failed to write row");

    // Read with filter chain: cf1 family, c1 qualifier only
    let read_request = ReadRowsRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        rows_limit: 1,
        rows: Some(RowSet {
            row_keys: vec![test_key.clone().into_bytes()],
            row_ranges: vec![],
        }),
        filter: Some(RowFilter {
            filter: Some(Filter::Chain(Chain {
                filters: vec![
                    RowFilter {
                        filter: Some(Filter::FamilyNameRegexFilter("cf1".to_owned())),
                    },
                    RowFilter {
                        filter: Some(Filter::ColumnQualifierRegexFilter("c1".as_bytes().to_vec())),
                    },
                ],
            })),
        }),
        ..ReadRowsRequest::default()
    };

    let response = bigtable.read_rows(read_request).await;
    assert!(
        response.is_ok(),
        "Failed to read rows: {:?}",
        response.err()
    );

    let rows = response.unwrap();
    assert_eq!(rows.len(), 1, "Expected 1 row");

    let (_, cells) = &rows[0];
    assert_eq!(
        cells.len(),
        1,
        "Expected 1 cell after filtering, got {}",
        cells.len()
    );
    assert_eq!(cells[0].family_name, "cf1");
    assert_eq!(String::from_utf8(cells[0].qualifier.clone()).unwrap(), "c1");
}

#[tokio::test]
async fn test_stream_rows() {
    global_setup().await;

    let connection: BigTableConnection = create_connection(false).await.expect("Failed to connect");
    let mut bigtable = connection.client();

    let prefix = format!("stream_test_{}_", std::process::id());

    // Write multiple rows
    for i in 1..=3 {
        let key = format!("{}{}", prefix, i);
        let write_request = MutateRowRequest {
            table_name: bigtable.get_full_table_name(TABLE_NAME),
            row_key: key.into_bytes(),
            mutations: vec![Mutation {
                mutation: Some(mutation::Mutation::SetCell(SetCell {
                    family_name: "cf1".to_owned(),
                    column_qualifier: "c1".to_owned().into_bytes(),
                    timestamp_micros: -1,
                    value: format!("stream_value{}", i).into_bytes(),
                })),
            }],
            ..MutateRowRequest::default()
        };
        bigtable
            .mutate_row(write_request)
            .await
            .expect("Failed to write row");
    }

    // Read using stream_rows
    let read_request = ReadRowsRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        rows_limit: 10,
        rows: Some(RowSet {
            row_keys: vec![],
            row_ranges: vec![RowRange {
                start_key: Some(StartKey::StartKeyClosed(
                    format!("{}1", prefix).into_bytes(),
                )),
                end_key: Some(EndKey::EndKeyOpen(format!("{}9", prefix).into_bytes())),
            }],
        }),
        filter: Some(RowFilter {
            filter: Some(Filter::CellsPerColumnLimitFilter(1)),
        }),
        ..ReadRowsRequest::default()
    };

    let mut stream = bigtable
        .stream_rows(read_request)
        .await
        .expect("Failed to create stream");

    let mut count = 0;
    while let Some((key, cells)) = stream.try_next().await.expect("Stream error") {
        assert!(
            String::from_utf8(key).unwrap().starts_with(&prefix),
            "Unexpected key prefix"
        );
        assert!(!cells.is_empty(), "Expected at least one cell");
        count += 1;
    }

    assert_eq!(count, 3, "Expected 3 rows from stream, got {}", count);
}

#[tokio::test]
async fn test_sample_row_keys() {
    global_setup().await;

    let connection: BigTableConnection = create_connection(true).await.expect("Failed to connect");
    let mut bigtable = connection.client();

    let request = SampleRowKeysRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        ..SampleRowKeysRequest::default()
    };

    let response = bigtable.sample_row_keys(request).await;
    assert!(
        response.is_ok(),
        "Failed to sample row keys: {:?}",
        response.err()
    );

    // The emulator should return at least one sample (or empty for small tables)
    // We just verify the call succeeds
    let mut stream = response.unwrap();
    let mut count = 0;
    while let Ok(Some(_)) = stream.message().await {
        count += 1;
    }
    // Sample row keys may return 0 results for small tables, which is valid
    println!("sample_row_keys returned {} samples", count);
}

#[tokio::test]
async fn test_read_nonexistent_row() {
    global_setup().await;

    let connection: BigTableConnection = create_connection(true).await.expect("Failed to connect");
    let mut bigtable = connection.client();

    let read_request = ReadRowsRequest {
        table_name: bigtable.get_full_table_name(TABLE_NAME),
        rows_limit: 1,
        rows: Some(RowSet {
            row_keys: vec!["nonexistent_key_12345".to_owned().into_bytes()],
            row_ranges: vec![],
        }),
        ..ReadRowsRequest::default()
    };

    let response = bigtable.read_rows(read_request).await;
    assert!(response.is_ok(), "Failed to read: {:?}", response.err());

    let rows = response.unwrap();
    assert!(rows.is_empty(), "Expected no rows for nonexistent key");
}