Skip to content

Commit 4a2a61f

Browse files
kyli87rtyler
andauthored
docs: remove references to default-engine feature (#2417)
## What changes are proposed in this pull request? The `default-engine` feature flag was removed in #1100 (several months ago) but the docs were never updated to reflect this. Instead, the feature flag should have an explicit suffix indicating which tls backend to use. This PR just updates the docs to reflect this. ## How was this change tested? n/a - just docs Co-authored-by: R. Tyler Croy <rtyler@brokenco.de>
1 parent c2e253b commit 4a2a61f

5 files changed

Lines changed: 13 additions & 14 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,10 @@ cargo +nightly fmt \
6161

6262
### Feature Flags
6363

64-
- `default-engine` / `default-engine-rustls` / `default-engine-native-tls` -- async
65-
Arrow/Tokio engine (pick one TLS backend)
64+
- `default-engine-rustls` / `default-engine-native-tls` -- async Arrow/Tokio engine (pick a TLS backend)
6665
- `arrow`, `arrow-XX`, `arrow-YY` -- Arrow version selection (kernel tracks the latest two
6766
major Arrow releases; `arrow` defaults to latest). Kernel itself does not depend on Arrow,
68-
but default-engine does.
67+
but the default engine does.
6968
- `arrow-conversion`, `arrow-expression` -- Arrow interop (auto-enabled by default engine)
7069
- `prettyprint` -- enables Arrow pretty-print helpers (primarily test/example oriented)
7170
- `clustered-table` -- clustered table write support (experimental)

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,17 @@ consumer's own `Engine` trait, the kernel has a feature flag to enable a default
5555
delta_kernel = "0.21.0"
5656

5757
# or turn on the default engine, based on latest arrow
58-
delta_kernel = { version = "0.21.0", features = ["default-engine", "arrow"] }
58+
delta_kernel = { version = "0.21.0", features = ["default-engine-rustls", "arrow"] }
5959
```
6060

6161
### Feature flags
62-
There are more feature flags in addition to the `default-engine` flag shown above. Relevant flags
63-
include:
62+
There are more feature flags in addition to the `default-engine-rustls` flag shown above. Relevant
63+
flags include:
6464

6565
| Feature flag | Description |
6666
| ------------- | ------------- |
67-
| `default-engine` | Turn on the 'default' engine: async, arrow-based `Engine` implementation |
67+
| `default-engine-rustls` | Turn on the 'default' engine with rustls TLS backend |
68+
| `default-engine-native-tls`| Turn on the 'default' engine with native-tls TLS backend |
6869
| `arrow-conversion` | Conversion utilities for arrow/kernel schema interoperation |
6970
| `arrow-expression` | Expression system implementation for arrow |
7071

@@ -74,8 +75,8 @@ are still unstable. We therefore may break APIs within minor releases (that is,
7475
we will not break APIs in patch releases (`0.1.0` -> `0.1.1`).
7576

7677
## Arrow versioning
77-
If you enable the `default-engine` feature, you get an implementation of the `Engine` trait that
78-
uses [Arrow] as its data format.
78+
If you enable a default engine feature (`default-engine-rustls` or `default-engine-native-tls`),
79+
you get an implementation of the `Engine` trait that uses [Arrow] as its data format.
7980

8081
The [`arrow crate`](https://docs.rs/arrow/latest/arrow/) tends to release new major versions rather
8182
frequently. To enable engines that already integrate arrow to also integrate kernel and not force

ffi/cbindgen.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ namespace = "ffi"
1111
cpp_compat = true
1212

1313
[defines]
14-
"feature = default-engine" = "DEFINE_DEFAULT_ENGINE"
1514
"feature = default-engine-rustls" = "DEFINE_DEFAULT_ENGINE_RUSTLS"
1615
"feature = default-engine-base" = "DEFINE_DEFAULT_ENGINE_BASE"
1716

kernel/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ arrow-expression = ["need-arrow"]
117117
# Schema diffing functionality (experimental)
118118
schema-diff = []
119119

120-
# this is an 'internal' feature flag which has all the shared bits from default-engine and
121-
# default-engine-rustls
120+
# this is an 'internal' feature flag which has all the shared bits from default-engine-native-tls
121+
# and default-engine-rustls
122122
default-engine-base = [
123123
"arrow-conversion",
124124
"arrow-expression",

kernel/src/engine/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Provides an engine implementation that implements the required traits. The engine can optionally
2-
//! be built into the kernel by setting the `default-engine` feature flag. See the related module
3-
//! for more information.
2+
//! be built into the kernel by setting the `default-engine-rustls` or `default-engine-native-tls`
3+
//! feature flag. See the related module for more information.
44
55
#[cfg(feature = "arrow-expression")]
66
use crate::parquet::arrow::arrow_reader::ArrowReaderOptions;

0 commit comments

Comments
 (0)