fix: docs

Signed-off-by: if0ne <[email protected]>

Author: if0ne

rust/core/src/lib.rs

@@ -31,10 +31,10 @@
 //! # Native Rust drivers
 //!
 //! Native Rust drivers will implement the abstract API consisting of the traits:
-//! - [Driver]
-//! - [Database]
-//! - [Connection]
-//! - [Statement]
+//! - [AsyncDriver]
+//! - [AsyncDatabase]
+//! - [AsyncConnection]
+//! - [AsyncStatement]
 //!
 //! For drivers implemented in Rust, using these will be more efficient and
 //! safe, since it avoids the overhead of going through C FFI.

rust/core/src/non_blocking.rs

@@ -24,10 +24,10 @@ use crate::error::Result;
 use crate::options::{self, *};
 
 /// Each data partition is described by an opaque byte array and can be
-/// retrieved with [Connection::read_partition].
+/// retrieved with [AsyncConnection::read_partition].
 pub type Partitions = Vec<Vec<u8>>;
 
-/// A partitioned result set as returned by [Statement::execute_partitions].
+/// A partitioned result set as returned by [AsyncStatement::execute_partitions].
 #[derive(Debug, PartialEq, Eq)]
 pub struct PartitionedResult {
     /// The result partitions.

rust/core/src/options.rs

@@ -218,7 +218,7 @@ impl TryFrom<u32> for InfoCode {
     }
 }
 
-/// Depth parameter for [get_objects][crate::Connection::get_objects] method.
+/// Depth parameter for [get_objects][crate::AsyncConnection::get_objects] method.
 #[derive(Debug)]
 pub enum ObjectDepth {
     /// Catalogs, schemas, tables, and columns.
@@ -374,19 +374,19 @@ pub enum OptionStatement {
     Temporary,
     /// Whether query execution is nonblocking. By default, execution is blocking.
     ///
-    /// When enabled, [execute_partitions][crate::Statement::execute_partitions]
+    /// When enabled, [execute_partitions][crate::AsyncStatement::execute_partitions]
     /// will return partitions as soon as they are available, instead of returning
     /// them all at the end. When there are no more to return, it will return an
-    /// empty set of partitions. The methods [execute][crate::Statement::execute],
-    /// [execute_schema][crate::Statement::execute_schema] and
-    /// [execute_update][crate::Statement::execute_update] are not affected.
+    /// empty set of partitions. The methods [execute][crate::AsyncStatement::execute],
+    /// [execute_schema][crate::AsyncStatement::execute_schema] and
+    /// [execute_update][crate::AsyncStatement::execute_update] are not affected.
     ///
     /// # Since
     ///
     /// ADBC API revision 1.1.0
     Incremental,
     /// Get the progress of a query. It's a read-only option that should be
-    /// read with [get_option_double][crate::Optionable::get_option_double].
+    /// read with [get_option_double][crate::AsyncOptionable::get_option_double].
     ///
     /// The value is not necessarily in any particular range or have any
     /// particular units. For example, it might be a percentage, bytes of data,
@@ -400,7 +400,7 @@ pub enum OptionStatement {
     /// ADBC API revision 1.1.0
     Progress,
     /// Get the maximum progress of a query. It's a read-only option that should be
-    /// read with [get_option_double][crate::Optionable::get_option_double].
+    /// read with [get_option_double][crate::AsyncOptionable::get_option_double].
     ///
     /// This is the value of [OptionStatement::Progress] for a completed query.
     /// If not supported, or if the value is nonpositive, then the maximum is not

rust/core/src/schemas.rs

@@ -21,7 +21,7 @@ use std::sync::{Arc, LazyLock};
 
 use arrow_schema::{DataType, Field, Schema, SchemaRef, UnionFields, UnionMode};
 
-/// Schema of the data returned by [get_table_types][crate::Connection::get_table_types].
+/// Schema of the data returned by [get_table_types][crate::AsyncConnection::get_table_types].
 pub static GET_TABLE_TYPES_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     Arc::new(Schema::new(vec![Field::new(
         "table_type",
@@ -30,7 +30,7 @@ pub static GET_TABLE_TYPES_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     )]))
 });
 
-/// Schema of the data returned by [get_info][crate::Connection::get_info].
+/// Schema of the data returned by [get_info][crate::AsyncConnection::get_info].
 pub static GET_INFO_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     let info_schema = DataType::Union(
         UnionFields::new(
@@ -64,7 +64,7 @@ pub static GET_INFO_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     ]))
 });
 
-/// Schema of data returned by [get_statistic_names][crate::Connection::get_statistic_names].
+/// Schema of data returned by [get_statistic_names][crate::AsyncConnection::get_statistic_names].
 pub static GET_STATISTIC_NAMES_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     Arc::new(Schema::new(vec![
         Field::new("statistic_name", DataType::Utf8, false),
@@ -114,7 +114,7 @@ pub static STATISTICS_DB_SCHEMA_SCHEMA: LazyLock<DataType> = LazyLock::new(|| {
     )
 });
 
-/// Schema of data returned by [get_statistics][crate::Connection::get_statistics].
+/// Schema of data returned by [get_statistics][crate::AsyncConnection::get_statistics].
 pub static GET_STATISTICS_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     Arc::new(Schema::new(vec![
         Field::new("catalog_name", DataType::Utf8, true),
@@ -219,7 +219,7 @@ pub static OBJECTS_DB_SCHEMA_SCHEMA: LazyLock<DataType> = LazyLock::new(|| {
     )
 });
 
-/// Schema of data returned by [get_objects][crate::Connection::get_objects].
+/// Schema of data returned by [get_objects][crate::AsyncConnection::get_objects].
 pub static GET_OBJECTS_SCHEMA: LazyLock<SchemaRef> = LazyLock::new(|| {
     Arc::new(Schema::new(vec![
         Field::new("catalog_name", DataType::Utf8, true),

rust/driver/datafusion/README.md

@@ -27,10 +27,10 @@
 
 ## Example Usage
 
-```
+```rust
 use adbc_core::driver_manager::ManagedDriver;
 use adbc_core::options::AdbcVersion;
-use adbc_core::{Connection, Database, Driver, Statement};
+use adbc_core::blocking::{Connection, Database, Driver, Statement};
 use arrow_cast::pretty::print_batches;
 use arrow_array::RecordBatch;
 

rust/driver/snowflake/README.md

@@ -31,7 +31,7 @@ driver, based on the
 ## Example
 
 ```rust,no_run
-use adbc_core::{Connection, Statement};
+use adbc_core::blocking::{Connection, Statement};
 use adbc_snowflake::{connection, database, Driver};
 use arrow_array::{cast::AsArray, types::Decimal128Type};
 

rust/driver/snowflake/src/database/builder.rs

@@ -490,7 +490,7 @@ impl Builder {
     pub const CLIENT_STORE_TEMP_CREDS_ENV: &str =
         "ADBC_SNOWFLAKE_SQL_CLIENT_OPTION_STORE_TEMP_CREDS";
 
-    /// See [`Self::]
+    /// See [`Self::client_identity_provider`]
     pub const CLIENT_IDENTITY_PROVIDER_ENV: &str =
         "ADBC_SNOWFLAKE_SQL_CLIENT_OPTION_IDENTITY_PROVIDER";
 

rust/driver_manager/src/lib.rs

@@ -50,7 +50,7 @@
 //! # use arrow_select::concat::concat_batches;
 //! # use adbc_core::{
 //! #     options::{AdbcVersion, OptionDatabase, OptionStatement},
-//! #     Connection, Database, Driver, Statement, Optionable
+//! #     blocking::{Connection, Database, Driver, Statement, Optionable}
 //! # };
 //! # use adbc_driver_manager::ManagedDriver;
 //! # fn main() -> Result<(), Box<dyn std::error::Error>> {

rust/ffi/src/lib.rs

@@ -34,7 +34,7 @@
 //!
 //! The driver exporter allows exposing native Rust drivers as C drivers to be
 //! used by other languages via their own driver manager. Once you have an
-//! implementation of [adbc_core::Driver], provided that it also implements [Default], you
+//! implementation of [adbc_core::blocking::Driver], provided that it also implements [Default], you
 //! can build it as an object file implementing the C API with the
 //! [export_driver] macro.