adbc_core 0.21.0

Public abstract API of ADBC
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

<!---
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->

# Arrow Database Connectivity for Rust

This is a Rust implementation of [Arrow Database Connectivity (ADBC)](https://arrow.apache.org/adbc).

It currently provides:

- An abstract Rust API to be implemented by vendor-specific drivers.
- A driver manager which implements this same API, but dynamically loads
  drivers internally and forwards calls appropriately using the C API.
- A driver exporter that takes an implementation of the abstract API and
  turns it into an object file that implements the C API.
- A dummy driver implementation for testing and documentation purposes.

## Development

To run the integration tests you must:

1. Install a recent version of [protobuf](https://github.com/protocolbuffers/protobuf) and have its `bin` (`protoc`) in path.
1. Install [SQLite](https://www.sqlite.org/) and have its dynamic library in path.
1. Build the official ADBC SQLite driver and ADBC Snowflake driver by following the [documentation](../CONTRIBUTING.md).
   * Add `-DADBC_DRIVER_SNOWFLAKE=ON` option to build the Snowflake driver.
1. Place the resulting object file into your dynamic loader path or set
   `LD_LIBRARY_PATH/DYLD_LIBRARY_PATH` appropriately.
1. Set `ADBC_SNOWFLAKE_GO_LIB_DIR` appropriately.
1. Run `cargo test --all-features --workspace`

## Writing Drivers

To write an ADBC driver in Rust you have to:

1. Create a new library crate with `crate-type = ["lib", "cdylib"]`.
1. Implement the abstract API which consists of the traits `Driver`, `Database`, `Connection` and `Statement`.
1. Export your driver to C with the macro `adbc_ffi::export_driver!`.

The resulting object file can then be loaded by other languages through their own driver manager.