20 releases (breaking)

new 0.15.0 Feb 23, 2021
0.14.0 Dec 25, 2020
0.13.0 Dec 4, 2020
0.12.0 Oct 18, 2020
0.4.0 Jul 30, 2020

#188 in Database interfaces

Download history 30/week @ 2020-11-04 11/week @ 2020-11-11 6/week @ 2020-11-18 17/week @ 2020-11-25 23/week @ 2020-12-02 31/week @ 2020-12-09 1/week @ 2020-12-16 18/week @ 2020-12-23 20/week @ 2020-12-30 5/week @ 2021-01-06 28/week @ 2021-01-13 22/week @ 2021-01-20 2/week @ 2021-01-27 4/week @ 2021-02-03 39/week @ 2021-02-10 67/week @ 2021-02-17

92 downloads per month
Used in r2d2_firebird

MIT license

375KB
8K SLoC

Rust Firebird Client

Build Crate API

A Firebird client library to Rust programing language

How to use

Examples

Goals

  • Rust Api
  • Dynamic link with fbclient
  • Dynamic loading the fbclient(.dll or .so)
  • ARM support
  • Firebird embedded support
  • Extern this api to ruby
  • Extern this api to lua (in a new repo)

lib.rs:

Rust Firebird Client

How to use it

1. Start by choosing the lib variation you want

// To use the offcial ('native') Firebird client .dll/.so/.dylib
// (needs to find dll at build time)
rsfbclient::builder_native().with_dyn_link()
// Or using dynamic loading
rsfbclient::builder_native().with_dyn_load("/my/firebird/here/lib/libfbclient.so")
// Or using the pure rust implementation
rsfbclient::builder_pure_rust()

2. Set your connection params

// For a remote server, using a dynamically linked native client
let mut conn = rsfbclient::builder_native()
    .with_dyn_link()
    .with_remote()
    .host("my.host.com.br")
    .db_name("awesome.fdb")
    .connect()?
// Or if you need a embedded/local only access
let mut conn = rsfbclient::builder_native()
    .with_dyn_link()
    .with_embedded()
    .db_name("/path/to/awesome.fdb")
    .connect()?

You also can choose a string connection configuration

// Using the native Firebird client
rsfbclient::builder_native()
    .from_string("firebird://SYSDBA:masterkey@my.host.com.br:3050/awesome.fdb?charset=ascii")
// Or using the pure rust implementation
rsfbclient::builder_pure_rust()
    .from_string("firebird://SYSDBA:masterkey@my.host.com.br:3050/awesome.fdb?charset=ascii")

3. Now you can use the lib

let rows = conn.query_iter("select col_a, col_b, col_c from test", ())?;
...

Simple Connection/Transaction

Sometimes you will need store the Connection and Transaction types into a struct field without care about Firebird Client variation. To do this, you can use the SimpleConnection and SimpleTransaction types.

To use, you only need use the From trait, calling the into() method. Example:

let mut conn: SimpleConnection = rsfbclient::builder_native()
    .with_dyn_link()
    .with_remote()
    .host("my.host.com.br")
    .db_name("awesome.fdb")
    .connect()?
    .into();

Cargo features

All features can be used at the same time if needed.

linking

Will use the dynamic library of the official fbclient at runtime and compiletime. Used in systems where there is already a firebird client installed and configured.

dynamic_loading

Can find the official fbclient native library by path at runtime, does not need the library at compiletime. Useful when you need to build in a system without a firebird client installed.

pure_rust

Uses a pure rust implementation of the firebird wire protocol, does not need the native library at all. Useful for cross-compilation and allow a single binary to be deployed without needing to install the firebird client.

Dependencies

~6.5MB
~152K SLoC