odbc-api 10.0.0

Write ODBC Applications in (mostly) safe 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

[package]
name = "odbc-api"
version = "10.0.0"
authors = ["Markus Klein"]
edition = "2021"
license = "MIT"
repository = "https://github.com/pacman82/odbc-api"
documentation = "https://docs.rs/odbc-api/"

# A short blurb about the package. This is not rendered in any format when
# uploaded to crates.io (aka this is not markdown).
description = "Write ODBC Applications in (mostly) safe Rust."

# This is a list of up to five keywords that describe this crate. Keywords
# are searchable on crates.io, and you may choose any words that would
# help someone find this crate.
keywords = ["odbc", "database", "sql"]

# This is a list of up to five categories where this crate would fit.
# Categories are a fixed list available at crates.io/category_slugs, and
# they must match exactly.
categories = ["api-bindings", "database"]

# This points to a file under the package root (relative to this `Cargo.toml`).
# The contents of this file are stored and indexed in the registry.
# crates.io will render this file and place the result on the crate's page.
readme = "../Readme.md"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[features]
# Use narrow function calls.
#
# Many functions which accept string arguments in the ODBC C API come in two different flavours. For
# example `SQLConnect` and `SQLConnectW`. The former are called narrow function calls and the latter
# are called wide. They differ in the type they used to encode characters (`u8` vs `u16`). Sadly
# narrow may not always be assumed to be UTF-8 as it is dependend on the system locale which is
# usually not UTF-8 on windows system. The wide function calls could be relied upon to always be
# UTF-16 on any platform, but do not seem to work well with iodbc and are less battle tested with
# Linux versions of ODBC drivers.
#
# Currently this library uses wide function call on windows systems by default. On non windows
# systems however narrow function calls are used. Enabling this feature will cause the use of
# the narrow function calls even on windows system. One reason to do so, would be e.g. you know your
# program is running on a windows system with an UTF-8 locale, and trust the driver to handle UTF-8
# appropriatly. If both `narrow` and `wide` work, `narrow` usually is faster and needs less encoding
# and decoding between string representations.
#
# Note that this is the encoding used for statement text and other string arguments, yet not for the
# payload of VARCHAR columns, or other column types in the result set. This can be choosen at
# runtime by the application.
narrow=[]

# Use wide function calls.
#
# See the documentation of `narrow` feature above for more information. Enabling this feature will
# trigger the use of `wide` function calls, even on "non-windows" platforms. If both `narrow` and
# `wide` are enabled, `wide` takes precedence.
wide=[]

# `odbc-api` uses ODBC 3.80 by default, which is well supported both in windows and on linux through
# `UnixODBC`. Yet iodbc, for now does only support ODBC 3.5, so you can set this flag in order to
# include only symbols available in ODBC 3.5 and create an environment which declares the ODBC
# version to be 3.0 which works together with the iodbc driver manager. If you want to use ODBC 3.5
# please take care to deactivate default features to not have the ODBC version 3.80 feature active
# at the same time.
odbc_version_3_5 = ["odbc-sys/odbc_version_3_50"]

# The ODBC version your application should declare if it runs on windows, or on linux using
# UnixOdbc.
odbc_version_3_80 = ["odbc-sys/odbc_version_3_80"]

# In order to work with iodbc we need to only use symbols defined in ODBC 3.5. We need to use
# narrow function calls and preferale link against `libiodbc.so` instead of `libodbc.so`.
iodbc = ["odbc_version_3_5", "narrow", "odbc-sys/iodbc"]

# Allows deriving custom implementations of `FetchRow` for row wise bulk fetching.
derive = ["dep:odbc-api-derive"]

default=["odbc_version_3_80"]

[dependencies]
# Low level bindings to ODBC API calls into libodbc.so
odbc-sys = { version = ">= 0.22, < 0.25", default-features = false }
# Used to generate code for the error type
thiserror = "2.0.3"
# Used as a log frontend to emit log messages for applications
log = "0.4.22"
# Interacting with UTF-16 texts for wide columns or wide function calls
widestring = "1.1.0"
atoi = "2.0.0"
odbc-api-derive ={ version = "9.0.1", path = "../derive", optional = true}

[target.'cfg(windows)'.dependencies]
# We use winit to display dialogs prompting for connection strings. We can deactivate default
# features since it can work only on windows and therfore we do not need any dependencies
# associated with various window managers.
winit = { version = "0.30.5", default-features = false, features = ["rwh_06"]}

[dev-dependencies]
env_logger = "0.11.5"
anyhow = "1.0.93"
csv = "1.3.1"
test-case = "3.3.1"
tempfile = "3.14.0"
criterion = { version = "0.5.1", features = ["html_reports"] }
tokio = { version = "1.41.1", features = ["rt", "macros", "time"] }
stdext = "0.3.3" # Used for function_name macro to generate unique table names for tests


[[bench]]
name = "benches"
harness = false