oracle_nosql_rust_sdk/lib.rs
1//
2// Copyright (c) 2024, 2025 Oracle and/or its affiliates. All rights reserved.
3//
4// Licensed under the Universal Permissive License v 1.0 as shown at
5// https://oss.oracle.com/licenses/upl/
6//
7//! Oracle NoSQL Database Rust SDK
8//!
9//! This is the Rust SDK for Oracle NoSQL Database. The SDK provides APIs and
10//! [examples](https://github.com/oracle/nosql-rust-sdk/tree/main/examples) to help
11//! developers write Rust applications that connect to the
12//! [Oracle NoSQL Database Cloud Service](https://www.oracle.com/database/nosql-cloud.html),
13//! the [Oracle NoSQL Database on-premises server](https://www.oracle.com/database/technologies/related/nosql.html)
14//! and to the [Oracle NoSQL Cloud Simulator](https://www.oracle.com/downloads/cloud/nosql-cloud-sdk-downloads.html).
15//!
16//! This SDK supplies and uses Rust `async` methods throughout. There is currently no blocking support.
17//!
18//! The general flow for an application using the Oracle NoSQL Database is:
19//! - Create a [`HandleBuilder`] with all needed parameters
20//! - Create a [`Handle`] from the [`HandleBuilder`] that will be used throughout the application, across all threads
21//! - Interact with the NoSQL Database using the [`Handle`] and Request structs such as [`GetRequest`], [`PutRequest`], [`QueryRequest`], etc.
22//!
23//! ## Simple Example
24//! The following code creates a NoSQL [`Handle`] from values in the the current environment and then reads a single record from a table in the database. For a more complete example, see the [Quickstart](#quickstart) below.
25//! ```no_run
26//! use oracle_nosql_rust_sdk::{Handle, GetRequest};
27//! use oracle_nosql_rust_sdk::types::MapValue;
28//! use std::error::Error;
29//!
30//! #[tokio::main]
31//! async fn main() -> Result<(), Box<dyn Error>> {
32//! let handle = Handle::builder()
33//! # .endpoint("http://localhost:8080")?
34//! # .mode(oracle_nosql_rust_sdk::HandleMode::Cloudsim)?
35//! .from_environment()?
36//! .build().await?;
37//! let getres = GetRequest::new("test_table")
38//! .key(MapValue::new().i32("id", 10))
39//! .execute(&handle)
40//! .await?;
41//! println!("GetResult={:?}", getres);
42//! Ok(())
43//! }
44//! ```
45//!
46//!
47//! ## Prerequisites
48//! - Rust 1.78 or later
49//! - Download and install a [Rust](https://www.rust-lang.org/tools/install) binary release suitable for your system. See the install and setup instructions on that page.
50//! - Oracle NoSQL Database. Use one of the options:
51//! - Subscribe to the [Oracle NoSQL Database Cloud Service](https://www.oracle.com/database/nosql-cloud.html).
52//! - Download the [Oracle NoSQL Cloud Simulator](https://www.oracle.com/downloads/cloud/nosql-cloud-sdk-downloads.html).
53//! - Download the Oracle NoSQL Database Server (on-premise) and the Oracle NoSQL
54//! Database Proxy (aka HTTP Proxy) at [here](https://www.oracle.com/database/technologies/nosql-database-server-downloads.html).
55//! ***NOTE***: The on-premise configuration requires a running instance of the HTTP Proxy,
56//! see the [Oracle NoSQL Database Proxy and Driver](https://docs.oracle.com/en/database/other-databases/nosql-database/22.3/admin/proxy-and-driver.html) for HTTP proxy configuration information.
57//!
58//!
59//! ## Installation
60//! The Rust SDK for Oracle NoSQL Database is published as a Rust crate. It is
61//! recommended to use the crates.io standard Rust mechanism for usage of this crate.
62//!
63//! To do so, add the following dependency to your `Cargo.toml` file:
64//! ```text
65//! [dependencies]
66//! oracle-nosql-rust-sdk = "0.1.0"
67//! ```
68//!
69//! ## Configuring the SDK
70//!
71//! This section describes configuring the SDK for the 3 environments supported:
72//!
73//! - **NoSQL DB Cloud Service**
74//! - **Cloud Simulator**
75//! - **NoSQL DB On-Premise**
76//!
77//! The areas where the environments and use differ are:
78//!
79//! - **Authentication and authorization.**
80//! - The **Cloud Service** is secure and requires a Cloud Service identity as well as authorization for desired operations.
81//! - The **Cloud Simulator** is not secure at all and requires no identity.
82//! - The **On-Premises** configuration can be either secure or not, and also requires an instance of the NoSQL DB Proxy service to access the on-premise database.
83//! - **API differences.** Some types and methods are specific to an environment. For example, the on-premise configuration includes methods to create namespaces and users and these concepts don’t exist in the cloud service. Similarly, the cloud service includes interfaces to specify and acquire throughput information on tables that is not relevant on-premise. Such differences are noted in the API documentation.
84//!
85//! Before using the Cloud Service, it is recommended that users start with the Cloud Simulator to become familiar with the interfaces supported by the SDK.
86//!
87//! ### Configure for the Cloud Service
88//!
89//! The SDK requires an Oracle Cloud account and a subscription to the Oracle NoSQL Database Cloud Service. If you do not already have an Oracle Cloud account you can start [here](https://cloud.oracle.com/home).
90//!
91//! There are several ways of specifying the cloud service credentials to use, including:
92//! - Instance Principals
93//! - Resource Principals
94//! - User Config File
95//!
96//! #### Using Instance Principal Credentials
97//!
98//! Instance Principal is an IAM service feature that enables instances to be authorized actors (or principals) to perform actions on service resources.
99//! If the application is running on an OCI compute instance in the Oracle Cloud,
100//! the SDK can make use of the instance environment to determine its credentials (no config file is required). Each compute instance has its own identity, and it authenticates using the certificates that are added to it. See [Calling Services from an Instance](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm) for prerequisite steps to set up Instance Principal.
101//!
102//! To configure NoSQL in this mode, use the [`HandleBuilder::cloud_auth_from_instance()`] method on the config struct.
103//!
104//! #### Using Resource Principal Credentials
105//!
106//! Resource Principal is an IAM service feature that enables the resources to be authorized actors (or principals) to perform actions on service resources. You may use Resource Principal when calling Oracle NoSQL Database Cloud Service from other Oracle Cloud service resource such as [Functions](https://docs.cloud.oracle.com/en-us/iaas/Content/Functions/Concepts/functionsoverview.htm). See [Accessing Other Oracle Cloud Infrastructure Resources from Running Functions](https://docs.cloud.oracle.com/en-us/iaas/Content/Functions/Tasks/functionsaccessingociresources.htm) for how to set up Resource Principal.
107//!
108//! To configure NoSQL in this mode, use the [`HandleBuilder::cloud_auth_from_resource()`] method on the config struct.
109//!
110//! #### Using User Config File to Specify OCI Credentials
111//!
112//! Several pieces of information comprise your credentials used by the Oracle NoSQL Database Cloud Service:
113//!
114//! - Tenancy ID
115//! - User ID
116//! - Fingerprint
117//! - Private Key File
118//! - Passphrase (optional)
119//! - Region (optional)
120//!
121//! Information about how to acquire this information is found in the [Required Keys and OCIDs](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm) page. Specifically, these topics can be found on that page:
122//!
123//! - [Where to Get the Tenancy’s OCID and User’s OCID](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Other)
124//! - [How to Generate an API Signing Key](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#How)
125//! - [How to Get the Key’s Fingerprint](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#How3)
126//! - [How to Upload the Public Key](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#How2)
127//!
128//! The way to supply the credentials is to use a credentials file, which by default is found in `$HOME/.oci/config` but the location can be specified in the API calls (see below).
129//!
130//! The format of the file is that of a properties file with the format of `key=value`, with one property per line. The contents and format are:
131//!
132//! ```ini
133//! [DEFAULT]
134//! tenancy=<your-tenancy-id>
135//! user=<your-user-id>
136//! fingerprint=<fingerprint-of-your-public-key>
137//! key_file=<path-to-your-private-key-file>
138//! pass_phrase=<optional-passphrase>
139//! region=<optional-region-identifier>
140//! ```
141//!
142//! Details of the configuration file can be found on the [SDK and Configuration File](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm) page. Note that multiple profiles can exist (using the `[PROFILENAME]` properties file convention) and can be selected using the API (see example below).
143//!
144//! The **Tenancy ID**, **User ID** and **fingerprint** should be acquired using the instructions above. The path to your private key file is the absolute path of the RSA private key. The order of the properties does not matter.
145//!
146//! The **region** is only required if [`HandleBuilder::cloud_region()`] is not used. It should specify the region of the NoSQL cloud service you are connecting to (for example: `us-phoenix-1`). For more information on regions, see [Regions and Availability Domains](https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm).
147//!
148//! The **pass_phrase** is only required if the RSA key file itself requires a passphrase.
149//!
150//! #### Using the Config to Connect an Application to the Cloud Service
151//!
152//! The first step in any Oracle NoSQL Database Cloud Service `rust` application is to create a [`Handle`] used to send requests to the service, based on the configuration given in a [`HandleBuilder`] struct. Instances of the Handle are safe for concurrent use by multiple goroutines and intended to be shared in a multi-threaded / async application.
153//!
154//! The following code example shows how to connect to the cloud service, using a user config file:
155//!
156//! ```no_run
157//! # use oracle_nosql_rust_sdk::Handle;
158//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
159//! let handle = Handle::builder()
160//! .cloud_auth_from_file("~/.oci/config")?
161//! .build().await?;
162//! // use handle for all NoSQL DB operations
163//! // ...
164//! # Ok(())
165//! # }
166//! ```
167//!
168//! ### Configure for the Cloud Simulator
169//!
170//! The Oracle NoSQL Cloud Simulator is a useful way to use this SDK to connect to a local server that supports the same protocol.
171//!
172//! See [Download the Oracle NoSQL Cloud Simulator](https://www.oracle.com/downloads/cloud/nosql-cloud-sdk-downloads.html) to download and start the Cloud Simulator.
173//!
174//! The Cloud Simulator should not be used for deploying production applications or important data, but it does allow for rapid development and testing.
175//!
176//! The Cloud Simulator does not require the credentials and authentication information required by the Oracle NoSQL Database Cloud Service, but the SDK does require an
177//! endpoint and the auth mode specifying Cloudsim:
178//!
179//! ```no_run
180//! # use oracle_nosql_rust_sdk::{Handle, HandleMode};
181//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
182//! let handle = Handle::builder()
183//! .mode(HandleMode::Cloudsim)?
184//! .endpoint("http://localhost:8080")?
185//! .build().await?;
186//! // use handle for all NoSQL DB operations
187//! // ...
188//! # Ok(())
189//! # }
190//! ```
191//!
192//! ### Configure for the On-Premise Oracle NoSQL Database
193//!
194//! The on-premise configuration requires a running instance of the Oracle NoSQL database. In addition a running proxy service is required. See [Oracle NoSQL Database Downloads](https://www.oracle.com/database/technologies/nosql-database-server-downloads.html) for downloads, and see [Information about the proxy](https://docs.oracle.com/en/database/other-databases/nosql-database/22.3/admin/proxy-and-driver.html) for proxy configuration information.
195//!
196//! In this case, the `endpoint` config parameter should point to the NoSQL proxy host and port location.
197//!
198//! If running a secure store, a user identity must be created in the store (separately) that has permission to perform the required operations of the application, such as manipulating tables and data. If the secure server has installed a certificate that is self-signed or is not trusted by the default system CA, specify [`HandleBuilder::danger_accept_invalid_certs()`] to instruct the client to skip verifying server's certificate, or specify the [`HandleBuilder::add_cert_from_pemfile()`] to verify server's certificate.
199//!
200//! ```no_run
201//! # use oracle_nosql_rust_sdk::Handle;
202//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
203//! let handle = Handle::builder()
204//! .endpoint("https://nosql.mycompany.com:8080")?
205//! .onprem_auth("testUser", "12345")?
206//! .danger_accept_invalid_certs(true)?
207//! // alternatively, specify a cert path
208//! // .add_cert_from_pemfile("/path/to/pemfile.pem")?
209//! .build().await?;
210//!
211//! // use handle for all NoSQL DB operations
212//! // ...
213//! # Ok(())
214//! # }
215//! ```
216//!
217//! If the store is not secure then the username and password are not required, but the mode
218//! is still required to differentiate between onprem and cloudsim installations:
219//!
220//! ```no_run
221//! # use oracle_nosql_rust_sdk::{Handle, HandleMode};
222//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
223//! let handle = Handle::builder()
224//! .mode(HandleMode::Onprem)?
225//! .endpoint("http://nosql.mycompany.com:8080")?
226//! .build().await?;
227//! // use handle for all NoSQL DB operations
228//! // ...
229//! # Ok(())
230//! # }
231//! ```
232//!
233//! ## Quickstart
234//!
235//! Below is a complete simple example program that opens a NoSQLDB handle, creates a simple table if it does not already exist, puts, gets, and deletes a row, then drops the table.
236//!
237//! The quickstart program can be used as a template which you can copy and modify as desired:
238//!
239//! ```no_run
240//! use oracle_nosql_rust_sdk::types::*;
241//! use oracle_nosql_rust_sdk::DeleteRequest;
242//! use oracle_nosql_rust_sdk::GetRequest;
243//! use oracle_nosql_rust_sdk::Handle;
244//! use oracle_nosql_rust_sdk::HandleMode;
245//! use oracle_nosql_rust_sdk::NoSQLError;
246//! use oracle_nosql_rust_sdk::PutRequest;
247//! use oracle_nosql_rust_sdk::QueryRequest;
248//! use oracle_nosql_rust_sdk::TableRequest;
249//! use std::error::Error;
250//! use std::time::Duration;
251//! use tracing::info;
252//!
253//! // This method shows various ways to configure a NoSQL Handle.
254//! async fn get_handle() -> Result<Handle, NoSQLError> {
255//! // Note: later methods called on this builder will override earlier methods.
256//! // This allows for setting desired defaults that can be overridden by, for example,
257//! // .from_environment().
258//! Handle::builder()
259//! // For local cloudsim: endpoint, Cloudsim mode:
260//! .endpoint("http://localhost:8080")?
261//! .mode(HandleMode::Cloudsim)?
262//! //
263//! // For on-premises: endpoint, Onprem mode:
264//! // .endpoint("https://my.company.com:8080")?
265//! // .mode(HandleMode::Onprem)?
266//! // Optional file with onprem secure login credentials
267//! // .onprem_auth_from_file("/path/to/user_pass_file")?
268//! // Optional path to x509 certificate in PEM format
269//! // .onprem_auth_from_file("/path/to/certificate.pem")?
270//! //
271//! // For cloud, using user-based file:
272//! // .cloud_auth_from_file("~/.oci/config")?
273//! // Optional region, if not specified in above file
274//! // .cloud_region("us-ashburn-1")?
275//! // Optional full endpoint, if region is not recognized
276//! //.endpoint("https://nosql.us-unknown-1.oci.oraclecloud.com")?
277//! //
278//! // For cloud, using Instance Principal:
279//! // .cloud_auth_from_instance()?
280//! //
281//! // For cloud, using Resource Principal:
282//! // .cloud_auth_from_resource()?
283//! //
284//! // To read all of the above from environment variables:
285//! .from_environment()?
286//! //
287//! // Optional: set a different default timeout (default is 30 seconds)
288//! .timeout(Duration::from_secs(15))?
289//! //
290//! // Build the handle
291//! .build()
292//! .await
293//! }
294//!
295//! // Example way to use multiple threaded tokio runtime
296//! #[tokio::main(flavor = "multi_thread", worker_threads = 4)]
297//! async fn main() -> Result<(), Box<dyn Error>> {
298//! // Set up a tracing subscriber to see output based on RUST_LOG environment setting
299//! tracing_subscriber::fmt()
300//! .with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
301//! .compact()
302//! .init();
303//!
304//! // Create a handle. This should be used throughout the program, across all threads
305//! info!("Creating new handle...");
306//! let handle = get_handle().await?;
307//!
308//! // Create an example table
309//! TableRequest::new("testusers")
310//! .statement(
311//! "create table if not exists testusers (id integer, name string,
312//! created timestamp(3), primary key(id))",
313//! )
314//! // the following line is only needed for Cloud mode
315//! .limits(&TableLimits::provisioned(1000, 1000, 10))
316//! .execute(&handle)
317//! .await?
318//! // wait up to 15 seconds for table to be created
319//! .wait_for_completion_ms(&handle, 15000, 500)
320//! .await?;
321//!
322//! // Put a record into the table
323//! // Note: ttl is a Duration, but internally is converted to a whole number of
324//! // hours or days. Minimum duration is one hour.
325//! let putres = PutRequest::new("testusers")
326//! .timeout(&Duration::from_millis(3000))
327//! .value(MapValue::new().i32("id", 10).str("name", "jane"))
328//! .ttl(&Duration::new(7200, 0))
329//! .execute(&handle)
330//! .await?;
331//! println!("PutResult={:?}", putres);
332//! // PutResult should have a version
333//! if putres.version().is_none() {
334//! return Err("PutRequest should have returned a version, but did not".into());
335//! }
336//!
337//! // Example of using if_version to overwrite existing record
338//! let putreq2 = PutRequest::new("testusers")
339//! .timeout(&Duration::from_millis(3000))
340//! .value(MapValue::new().i32("id", 10).str("name", "john"))
341//! .if_version(&putres.version().unwrap())
342//! .ttl(&Duration::new(7200, 0));
343//! println!("Putreq2={:?}", putreq2);
344//! let putres2 = putreq2.execute(&handle).await?;
345//! println!("PutResult2={:?}", putres2);
346//!
347//! // Get the record back
348//! let getres = GetRequest::new("testusers")
349//! .key(MapValue::new().i32("id", 10))
350//! .consistency(Consistency::Eventual)
351//! .execute(&handle)
352//! .await?;
353//! println!("GetResult={:?}", getres);
354//! // GetResult should have a version
355//! if getres.version().is_none() {
356//! return Err("GetRequest should have returned a version, but did not".into());
357//! }
358//!
359//! // write in some more records, so query below has more to return
360//! for i in 20..30 {
361//! //let name = format!("name{}", i);
362//! let name = "somename".to_string();
363//! let _ = PutRequest::new("testusers")
364//! .value(
365//! MapValue::new()
366//! .i32("id", i)
367//! .str("name", name.as_str()),
368//! )
369//! .execute(&handle)
370//! .await?;
371//! // Optional delay between puts, if desired
372//! // tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
373//! }
374//!
375//! // Simple query of all rows
376//! let qres = QueryRequest::new("select * from testusers")
377//! .execute(&handle)
378//! .await?;
379//! println!("QueryResult = {:?}", qres);
380//!
381//! // Query with ordering
382//! let qres1 = QueryRequest::new("select * from testusers order by id")
383//! .execute(&handle)
384//! .await?;
385//! println!("QueryResult1 = {:?}", qres1);
386//!
387//! // Example of how to remove a record with if_version
388//! let delres = DeleteRequest::new("testusers", MapValue::new().i32("id", 10))
389//! .if_version(&getres.version().unwrap())
390//! .execute(&handle)
391//! .await?;
392//! println!("delres={:?}", delres);
393//!
394//! // Drop the table
395//! TableRequest::new("testusers")
396//! .statement("drop table if exists testusers")
397//! .execute(&handle)
398//! .await?
399//! .wait_for_completion_ms(&handle, 15000, 500)
400//! .await?;
401//!
402//! Ok(())
403//! }
404//! ```
405//!
406//! Create a directory `quickstart` and `quickstart/src`, save the example program as `main.rs` in the `quickstart/src` directory.
407//!
408//! Add a `Cargo.toml` file to the `quickstart` directory:
409//! ```text
410//! [package]
411//! name = "quickstart"
412//! version = "0.1.0"
413//! edition = "2021"
414//!
415//! [dependencies]
416//! tokio = { version = "1.38.0", features = ["full"] }
417//! chrono = { version = "0.4.31", features = ["alloc", "std"] }
418//! oracle-nosql-rust-sdk = { version = "0.1" }
419//! tracing = "0.1.40"
420//! tracing-subscriber = { version = "0.3", features = ["env-filter", "std"] }
421//! ```
422//! Run the example program with the commands:
423//!
424//! ```sh
425//! cd quickstart
426//!
427//! cargo build
428//!
429//! cargo run
430//! ```
431//!
432//! ## Examples
433//!
434//! Examples can be found at the [**examples**](https://github.com/oracle/nosql-rust-sdk/blob/main/examples)
435//! directory. Examples include simple, standalone programs that show the Rust API usages.
436//! They include comments about how they can be configured and run in the different
437//! supported environments.
438//!
439//! ## Help
440//!
441//! There are a few ways to get help or report issues:
442//! - Open an issue in the [Issues](https://github.com/oracle/nosql-rust-sdk/issues) page.
443//! - Post your question on the [Oracle NoSQL Database Community](https://forums.oracle.com/ords/apexds/domain/dev-community/category/nosql_database).
444//! - [Email to nosql\_sdk\_help\_grp@oracle.com](mailto:nosql_sdk_help_grp@oracle.com)
445//!
446//! When requesting help please be sure to include as much detail as possible,
447//! including version of the SDK and **simple**, standalone example code as needed.
448//!
449//! ## Changes
450//!
451//! See the [Changelog](https://github.com/oracle/nosql-rust-sdk/blob/main/CHANGELOG.md).
452//!
453//! ## Contributing
454//!
455//! This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
456//!
457//! ## Security
458//!
459//! Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
460//!
461//! ## License
462//!
463//! Copyright (C) 2019, 2024, 2025 Oracle and/or its affiliates. All rights reserved.
464//!
465//! This SDK is licensed under the Universal Permissive License 1.0. See
466//! [LICENSE](https://github.com/oracle/nosql-rust-sdk/blob/main/LICENSE.txt) for
467//! details.
468//!
469
470pub(crate) mod handle_builder;
471pub use crate::handle_builder::{HandleBuilder, HandleMode};
472
473pub(crate) mod handle;
474pub use crate::handle::Handle;
475
476pub(crate) mod aggr_iter;
477pub(crate) mod arith_op_iter;
478pub(crate) mod auth_common;
479pub use crate::auth_common::authentication_provider::AuthenticationProvider;
480
481pub(crate) mod collect_iter;
482pub(crate) mod const_iter;
483pub(crate) mod delete_request;
484pub use crate::delete_request::{DeleteRequest, DeleteResult};
485
486pub(crate) mod error;
487pub use crate::error::{NoSQLError, NoSQLErrorCode};
488
489pub(crate) mod ext_var_iter;
490pub(crate) mod field_step_iter;
491pub(crate) mod get_indexes_request;
492pub use crate::get_indexes_request::{GetIndexesRequest, GetIndexesResult, IndexInfo};
493
494pub(crate) mod get_request;
495pub use crate::get_request::{GetRequest, GetResult};
496
497pub(crate) mod group_iter;
498pub(crate) mod list_tables_request;
499pub use crate::list_tables_request::{ListTablesRequest, ListTablesResult};
500
501#[cfg(test)]
502pub(crate) mod mapvalue_tests;
503pub(crate) mod multi_delete_request;
504pub use crate::multi_delete_request::{FieldRange, MultiDeleteRequest, MultiDeleteResult};
505
506pub(crate) mod nson;
507pub(crate) mod packed_integer;
508pub(crate) mod plan_iter;
509pub(crate) mod prepared_statement;
510pub use crate::prepared_statement::PreparedStatement;
511
512pub(crate) mod put_request;
513pub use crate::put_request::{PutRequest, PutResult};
514
515#[cfg(test)]
516pub(crate) mod qtf;
517#[cfg(test)]
518pub(crate) mod qtf_custom_setup;
519#[cfg(test)]
520pub(crate) mod qtf_tests;
521pub(crate) mod query_request;
522pub use crate::query_request::{QueryRequest, QueryResult};
523
524pub(crate) mod reader;
525pub(crate) mod receive_iter;
526pub(crate) mod region;
527
528#[cfg(test)]
529pub(crate) mod request_tests;
530#[cfg(test)]
531pub(crate) mod rw_tests;
532pub(crate) mod sfw_iter;
533pub(crate) mod size_iter;
534pub(crate) mod sort_iter;
535pub(crate) mod system_request;
536pub use crate::system_request::{SystemRequest, SystemResult};
537
538pub(crate) mod table_request;
539pub use crate::table_request::{GetTableRequest, TableRequest, TableResult};
540
541pub(crate) mod table_usage_request;
542pub use crate::table_usage_request::{TableUsage, TableUsageRequest, TableUsageResult};
543
544pub mod types;
545/// Type representing a specific version of a table row in the NoSQL Database.
546pub type Version = Vec<u8>;
547pub use crate::types::NoSQLColumnToFieldValue;
548
549pub(crate) mod var_ref_iter;
550pub(crate) mod write_multiple_request;
551pub use crate::write_multiple_request::{
552 SubOperationResult, WriteMultipleRequest, WriteMultipleResult,
553};
554pub(crate) mod writer;