Compare commits

..

3 Commits

Author SHA1 Message Date
Copilot
16cce185fc chore: translate Chinese comments to English in bump-versions.ts (#7424)
* Initial plan

* chore: translate Chinese comments to English in bump-versions.ts

Co-authored-by: discord9 <55937128+discord9@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: discord9 <55937128+discord9@users.noreply.github.com>
2025-12-17 11:32:32 +08:00
discord9
35624ffdfe Merge branch 'main' into chore/manual_pre_release_docs 2025-12-17 11:05:42 +08:00
discord9
aab2c7343a chore: manually choose pre release docs?
Signed-off-by: discord9 <discord9@163.com>
2025-11-12 11:33:20 +08:00
430 changed files with 5892 additions and 24269 deletions

View File

@@ -51,7 +51,7 @@ runs:
run: | run: |
helm upgrade \ helm upgrade \
--install my-greptimedb \ --install my-greptimedb \
--set 'meta.backendStorage.etcd.endpoints[0]=${{ inputs.etcd-endpoints }}' \ --set meta.backendStorage.etcd.endpoints=${{ inputs.etcd-endpoints }} \
--set meta.enableRegionFailover=${{ inputs.enable-region-failover }} \ --set meta.enableRegionFailover=${{ inputs.enable-region-failover }} \
--set image.registry=${{ inputs.image-registry }} \ --set image.registry=${{ inputs.image-registry }} \
--set image.repository=${{ inputs.image-repository }} \ --set image.repository=${{ inputs.image-repository }} \
@@ -70,23 +70,19 @@ runs:
--wait \ --wait \
--wait-for-jobs --wait-for-jobs
- name: Wait for GreptimeDB - name: Wait for GreptimeDB
uses: nick-fields/retry@v3 shell: bash
with: run: |
timeout_minutes: 3 while true; do
max_attempts: 1 PHASE=$(kubectl -n my-greptimedb get gtc my-greptimedb -o jsonpath='{.status.clusterPhase}')
shell: bash if [ "$PHASE" == "Running" ]; then
command: | echo "Cluster is ready"
while true; do break
PHASE=$(kubectl -n my-greptimedb get gtc my-greptimedb -o jsonpath='{.status.clusterPhase}') else
if [ "$PHASE" == "Running" ]; then echo "Cluster is not ready yet: Current phase: $PHASE"
echo "Cluster is ready" kubectl get pods -n my-greptimedb
break sleep 5 # wait for 5 seconds before check again.
else fi
echo "Cluster is not ready yet: Current phase: $PHASE" done
kubectl get pods -n my-greptimedb
sleep 5 # wait for 5 seconds before check again.
fi
done
- name: Print GreptimeDB info - name: Print GreptimeDB info
if: always() if: always()
shell: bash shell: bash

View File

@@ -49,17 +49,6 @@ function create_version() {
echo "GITHUB_REF_NAME is empty in push event" >&2 echo "GITHUB_REF_NAME is empty in push event" >&2
exit 1 exit 1
fi fi
# For tag releases, ensure GITHUB_REF_NAME matches the version in Cargo.toml
CARGO_VERSION=$(grep '^version = ' Cargo.toml | cut -d '"' -f 2 | head -n 1)
EXPECTED_REF_NAME="v${CARGO_VERSION}"
if [ "$GITHUB_REF_NAME" != "$EXPECTED_REF_NAME" ]; then
echo "Error: GITHUB_REF_NAME '$GITHUB_REF_NAME' does not match Cargo.toml version 'v${CARGO_VERSION}'" >&2
echo "Expected tag name: '$EXPECTED_REF_NAME'" >&2
exit 1
fi
echo "$GITHUB_REF_NAME" echo "$GITHUB_REF_NAME"
elif [ "$GITHUB_EVENT_NAME" = workflow_dispatch ]; then elif [ "$GITHUB_EVENT_NAME" = workflow_dispatch ]; then
echo "$NEXT_RELEASE_VERSION-$(git rev-parse --short HEAD)-$(date "+%Y%m%d-%s")" echo "$NEXT_RELEASE_VERSION-$(git rev-parse --short HEAD)-$(date "+%Y%m%d-%s")"

View File

@@ -81,7 +81,7 @@ function deploy_greptimedb_cluster() {
--create-namespace \ --create-namespace \
--set image.tag="$GREPTIMEDB_IMAGE_TAG" \ --set image.tag="$GREPTIMEDB_IMAGE_TAG" \
--set initializer.tag="$GREPTIMEDB_INITIALIZER_IMAGE_TAG" \ --set initializer.tag="$GREPTIMEDB_INITIALIZER_IMAGE_TAG" \
--set "meta.backendStorage.etcd.endpoints[0]=etcd.$install_namespace.svc.cluster.local:2379" \ --set meta.backendStorage.etcd.endpoints="etcd.$install_namespace:2379" \
--set meta.backendStorage.etcd.storeKeyPrefix="$cluster_name" \ --set meta.backendStorage.etcd.storeKeyPrefix="$cluster_name" \
-n "$install_namespace" -n "$install_namespace"
@@ -119,7 +119,7 @@ function deploy_greptimedb_cluster_with_s3_storage() {
--create-namespace \ --create-namespace \
--set image.tag="$GREPTIMEDB_IMAGE_TAG" \ --set image.tag="$GREPTIMEDB_IMAGE_TAG" \
--set initializer.tag="$GREPTIMEDB_INITIALIZER_IMAGE_TAG" \ --set initializer.tag="$GREPTIMEDB_INITIALIZER_IMAGE_TAG" \
--set "meta.backendStorage.etcd.endpoints[0]=etcd.$install_namespace.svc.cluster.local:2379" \ --set meta.backendStorage.etcd.endpoints="etcd.$install_namespace:2379" \
--set meta.backendStorage.etcd.storeKeyPrefix="$cluster_name" \ --set meta.backendStorage.etcd.storeKeyPrefix="$cluster_name" \
--set objectStorage.s3.bucket="$AWS_CI_TEST_BUCKET" \ --set objectStorage.s3.bucket="$AWS_CI_TEST_BUCKET" \
--set objectStorage.s3.region="$AWS_REGION" \ --set objectStorage.s3.region="$AWS_REGION" \

View File

@@ -1,154 +0,0 @@
name: Check Git Dependencies on Main Branch
on:
pull_request:
branches: [main]
paths:
- 'Cargo.toml'
push:
branches: [main]
paths:
- 'Cargo.toml'
jobs:
check-git-deps:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Check git dependencies
env:
WHITELIST_DEPS: "greptime-proto,meter-core,meter-macros"
run: |
#!/bin/bash
set -e
echo "Checking whitelisted git dependencies..."
# Function to check if a commit is on main branch
check_commit_on_main() {
local repo_url="$1"
local commit="$2"
local repo_name=$(basename "$repo_url" .git)
echo "Checking $repo_name"
echo "Repo: $repo_url"
echo "Commit: $commit"
# Create a temporary directory for cloning
local temp_dir=$(mktemp -d)
# Clone the repository
if git clone "$repo_url" "$temp_dir" 2>/dev/null; then
cd "$temp_dir"
# Try to determine the main branch name
local main_branch="main"
if ! git rev-parse --verify origin/main >/dev/null 2>&1; then
if git rev-parse --verify origin/master >/dev/null 2>&1; then
main_branch="master"
else
# Try to get the default branch
main_branch=$(git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@')
fi
fi
echo "Main branch: $main_branch"
# Check if commit exists
if git cat-file -e "$commit" 2>/dev/null; then
# Check if commit is on main branch
if git merge-base --is-ancestor "$commit" "origin/$main_branch" 2>/dev/null; then
echo "PASS: Commit $commit is on $main_branch branch"
cd - >/dev/null
rm -rf "$temp_dir"
return 0
else
echo "FAIL: Commit $commit is NOT on $main_branch branch"
# Try to find which branch contains this commit
local branch_name=$(git branch -r --contains "$commit" 2>/dev/null | head -1 | sed 's/^[[:space:]]*origin\///' | sed 's/[[:space:]]*$//')
if [[ -n "$branch_name" ]]; then
echo "Found on branch: $branch_name"
fi
cd - >/dev/null
rm -rf "$temp_dir"
return 1
fi
else
echo "FAIL: Commit $commit not found in repository"
cd - >/dev/null
rm -rf "$temp_dir"
return 1
fi
else
echo "FAIL: Failed to clone $repo_url"
rm -rf "$temp_dir"
return 1
fi
}
# Extract whitelisted git dependencies from Cargo.toml
echo "Extracting git dependencies from Cargo.toml..."
# Create temporary array to store dependencies
declare -a deps=()
# Build awk pattern from whitelist
IFS=',' read -ra WHITELIST <<< "$WHITELIST_DEPS"
awk_pattern=""
for dep in "${WHITELIST[@]}"; do
if [[ -n "$awk_pattern" ]]; then
awk_pattern="$awk_pattern|"
fi
awk_pattern="$awk_pattern$dep"
done
# Extract whitelisted dependencies
while IFS= read -r line; do
if [[ -n "$line" ]]; then
deps+=("$line")
fi
done < <(awk -v pattern="$awk_pattern" '
$0 ~ pattern ".*git = \"https:/" {
match($0, /git = "([^"]+)"/, arr)
git_url = arr[1]
if (match($0, /rev = "([^"]+)"/, rev_arr)) {
rev = rev_arr[1]
print git_url " " rev
} else {
# Check next line for rev
getline
if (match($0, /rev = "([^"]+)"/, rev_arr)) {
rev = rev_arr[1]
print git_url " " rev
}
}
}
' Cargo.toml)
echo "Found ${#deps[@]} dependencies to check:"
for dep in "${deps[@]}"; do
echo " $dep"
done
failed=0
for dep in "${deps[@]}"; do
read -r repo_url commit <<< "$dep"
if ! check_commit_on_main "$repo_url" "$commit"; then
failed=1
fi
done
echo "Check completed."
if [[ $failed -eq 1 ]]; then
echo "ERROR: Some git dependencies are not on their main branches!"
echo "Please update the commits to point to main branch commits."
exit 1
else
echo "SUCCESS: All git dependencies are on their main branches!"
fi

View File

@@ -755,7 +755,7 @@ jobs:
run: ../../.github/scripts/pull-test-deps-images.sh && docker compose up -d --wait run: ../../.github/scripts/pull-test-deps-images.sh && docker compose up -d --wait
- name: Run nextest cases - name: Run nextest cases
run: cargo nextest run --workspace -F dashboard -F pg_kvbackend -F mysql_kvbackend -F vector_index run: cargo nextest run --workspace -F dashboard -F pg_kvbackend -F mysql_kvbackend
env: env:
CARGO_BUILD_RUSTFLAGS: "-C link-arg=-fuse-ld=mold" CARGO_BUILD_RUSTFLAGS: "-C link-arg=-fuse-ld=mold"
RUST_BACKTRACE: 1 RUST_BACKTRACE: 1
@@ -813,7 +813,7 @@ jobs:
run: ../../.github/scripts/pull-test-deps-images.sh && docker compose up -d --wait run: ../../.github/scripts/pull-test-deps-images.sh && docker compose up -d --wait
- name: Run nextest cases - name: Run nextest cases
run: cargo llvm-cov nextest --workspace --lcov --output-path lcov.info -F dashboard -F pg_kvbackend -F mysql_kvbackend -F vector_index run: cargo llvm-cov nextest --workspace --lcov --output-path lcov.info -F dashboard -F pg_kvbackend -F mysql_kvbackend
env: env:
CARGO_BUILD_RUSTFLAGS: "-C link-arg=-fuse-ld=mold" CARGO_BUILD_RUSTFLAGS: "-C link-arg=-fuse-ld=mold"
RUST_BACKTRACE: 1 RUST_BACKTRACE: 1

3
.gitignore vendored
View File

@@ -67,6 +67,3 @@ greptimedb_data
# Claude code # Claude code
CLAUDE.md CLAUDE.md
# AGENTS.md
AGENTS.md

View File

@@ -15,11 +15,8 @@ repos:
rev: v1.0 rev: v1.0
hooks: hooks:
- id: fmt - id: fmt
args: ["--", "--check"]
stages: [commit-msg]
- id: clippy - id: clippy
args: ["--workspace", "--all-targets", "--all-features", "--", "-D", "warnings"] args: ["--workspace", "--all-targets", "--all-features", "--", "-D", "warnings"]
stages: [commit-msg] stages: [pre-push]
- id: cargo-check - id: cargo-check
args: ["--workspace", "--all-targets", "--all-features"] args: ["--workspace", "--all-targets", "--all-features"]
stages: [commit-msg]

View File

@@ -102,30 +102,6 @@ like `feat`/`fix`/`docs`, with a concise summary of code change following. AVOID
All commit messages SHOULD adhere to the [Conventional Commits specification](https://conventionalcommits.org/). All commit messages SHOULD adhere to the [Conventional Commits specification](https://conventionalcommits.org/).
## AI-Assisted contributions
We have the following policy for AI-assisted PRs:
- The PR author should **understand the core ideas** behind the implementation **end-to-end**, and be able to justify the design and code during review.
- **Calls out unknowns and assumptions**. It's okay to not fully understand some bits of AI generated code. You should comment on these cases and point them out to reviewers so that they can use their knowledge of the codebase to clear up any concerns. For example, you might comment "calling this function here seems to work but I'm not familiar with how it works internally, I wonder if there's a race condition if it is called concurrently".
### Why fully AI-generated PRs without understanding are not helpful
Today, AI tools cannot reliably make complex changes to GreptimeDB on their own, which is why we rely on pull requests and code review.
The purposes of code review are:
1. Finish the intended task.
2. Share knowledge between authors and reviewers, as a long-term investment in the project. For this reason, even if someone familiar with the codebase can finish a task quickly, we're still happy to help a new contributor work on it even if it takes longer.
An AI dump for an issue doesnt meet these purposes. Maintainers could finish the task faster by using AI directly, and the submitters gain little knowledge if they act only as a pass through AI proxy without understanding.
Please understand the reviewing capacity is **very limited** for the project, so large PRs which appear to not have the requisite understanding might not get reviewed, and eventually closed or redirected.
### Better ways to contribute than an “AI dump”
It's recommended to write a high-quality issue with a clear problem statement and a minimal, reproducible example. This can make it easier for others to contribute.
## Getting Help ## Getting Help
There are many ways to get help when you're stuck. It is recommended to ask for help by opening an issue, with a detailed description There are many ways to get help when you're stuck. It is recommended to ask for help by opening an issue, with a detailed description

226
Cargo.lock generated
View File

@@ -212,7 +212,7 @@ checksum = "d301b3b94cb4b2f23d7917810addbbaff90738e0ca2be692bd027e70d7e0330c"
[[package]] [[package]]
name = "api" name = "api"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arrow-schema", "arrow-schema",
"common-base", "common-base",
@@ -733,7 +733,7 @@ dependencies = [
[[package]] [[package]]
name = "auth" name = "auth"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -1383,7 +1383,7 @@ dependencies = [
[[package]] [[package]]
name = "cache" name = "cache"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"catalog", "catalog",
"common-error", "common-error",
@@ -1418,7 +1418,7 @@ checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5"
[[package]] [[package]]
name = "catalog" name = "catalog"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arrow", "arrow",
@@ -1763,7 +1763,7 @@ checksum = "b94f61472cee1439c0b966b47e3aca9ae07e45d070759512cd390ea2bebc6675"
[[package]] [[package]]
name = "cli" name = "cli"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-stream", "async-stream",
"async-trait", "async-trait",
@@ -1786,7 +1786,6 @@ dependencies = [
"common-recordbatch", "common-recordbatch",
"common-runtime", "common-runtime",
"common-telemetry", "common-telemetry",
"common-test-util",
"common-time", "common-time",
"common-version", "common-version",
"common-wal", "common-wal",
@@ -1817,7 +1816,7 @@ dependencies = [
[[package]] [[package]]
name = "client" name = "client"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arc-swap", "arc-swap",
@@ -1850,7 +1849,7 @@ dependencies = [
"snafu 0.8.6", "snafu 0.8.6",
"store-api", "store-api",
"substrait 0.37.3", "substrait 0.37.3",
"substrait 1.0.0-beta.4", "substrait 1.0.0-beta.2",
"tokio", "tokio",
"tokio-stream", "tokio-stream",
"tonic 0.13.1", "tonic 0.13.1",
@@ -1890,7 +1889,7 @@ dependencies = [
[[package]] [[package]]
name = "cmd" name = "cmd"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"auth", "auth",
@@ -2024,7 +2023,7 @@ checksum = "55b672471b4e9f9e95499ea597ff64941a309b2cdbffcc46f2cc5e2d971fd335"
[[package]] [[package]]
name = "common-base" name = "common-base"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"anymap2", "anymap2",
"async-trait", "async-trait",
@@ -2048,14 +2047,14 @@ dependencies = [
[[package]] [[package]]
name = "common-catalog" name = "common-catalog"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"const_format", "const_format",
] ]
[[package]] [[package]]
name = "common-config" name = "common-config"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-base", "common-base",
"common-error", "common-error",
@@ -2080,7 +2079,7 @@ dependencies = [
[[package]] [[package]]
name = "common-datasource" name = "common-datasource"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arrow", "arrow",
"arrow-schema", "arrow-schema",
@@ -2115,7 +2114,7 @@ dependencies = [
[[package]] [[package]]
name = "common-decimal" name = "common-decimal"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"bigdecimal 0.4.8", "bigdecimal 0.4.8",
"common-error", "common-error",
@@ -2128,7 +2127,7 @@ dependencies = [
[[package]] [[package]]
name = "common-error" name = "common-error"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-macro", "common-macro",
"http 1.3.1", "http 1.3.1",
@@ -2139,7 +2138,7 @@ dependencies = [
[[package]] [[package]]
name = "common-event-recorder" name = "common-event-recorder"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -2161,7 +2160,7 @@ dependencies = [
[[package]] [[package]]
name = "common-frontend" name = "common-frontend"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -2183,14 +2182,13 @@ dependencies = [
[[package]] [[package]]
name = "common-function" name = "common-function"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"api", "api",
"approx 0.5.1", "approx 0.5.1",
"arc-swap", "arc-swap",
"arrow", "arrow",
"arrow-cast",
"arrow-schema", "arrow-schema",
"async-trait", "async-trait",
"bincode", "bincode",
@@ -2221,7 +2219,6 @@ dependencies = [
"h3o", "h3o",
"hyperloglogplus", "hyperloglogplus",
"jsonb", "jsonb",
"jsonpath-rust 0.7.5",
"memchr", "memchr",
"mito-codec", "mito-codec",
"nalgebra", "nalgebra",
@@ -2245,7 +2242,7 @@ dependencies = [
[[package]] [[package]]
name = "common-greptimedb-telemetry" name = "common-greptimedb-telemetry"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"common-runtime", "common-runtime",
@@ -2262,7 +2259,7 @@ dependencies = [
[[package]] [[package]]
name = "common-grpc" name = "common-grpc"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arrow-flight", "arrow-flight",
@@ -2297,7 +2294,7 @@ dependencies = [
[[package]] [[package]]
name = "common-grpc-expr" name = "common-grpc-expr"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"common-base", "common-base",
@@ -2317,7 +2314,7 @@ dependencies = [
[[package]] [[package]]
name = "common-macro" name = "common-macro"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"greptime-proto", "greptime-proto",
"once_cell", "once_cell",
@@ -2328,7 +2325,7 @@ dependencies = [
[[package]] [[package]]
name = "common-mem-prof" name = "common-mem-prof"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"common-error", "common-error",
@@ -2344,7 +2341,7 @@ dependencies = [
[[package]] [[package]]
name = "common-memory-manager" name = "common-memory-manager"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-error", "common-error",
"common-macro", "common-macro",
@@ -2357,7 +2354,7 @@ dependencies = [
[[package]] [[package]]
name = "common-meta" name = "common-meta"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"anymap2", "anymap2",
"api", "api",
@@ -2429,7 +2426,7 @@ dependencies = [
[[package]] [[package]]
name = "common-options" name = "common-options"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-grpc", "common-grpc",
"humantime-serde", "humantime-serde",
@@ -2438,11 +2435,11 @@ dependencies = [
[[package]] [[package]]
name = "common-plugins" name = "common-plugins"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
[[package]] [[package]]
name = "common-pprof" name = "common-pprof"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-error", "common-error",
"common-macro", "common-macro",
@@ -2454,7 +2451,7 @@ dependencies = [
[[package]] [[package]]
name = "common-procedure" name = "common-procedure"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-stream", "async-stream",
@@ -2483,7 +2480,7 @@ dependencies = [
[[package]] [[package]]
name = "common-procedure-test" name = "common-procedure-test"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"common-procedure", "common-procedure",
@@ -2493,7 +2490,7 @@ dependencies = [
[[package]] [[package]]
name = "common-query" name = "common-query"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -2519,7 +2516,7 @@ dependencies = [
[[package]] [[package]]
name = "common-recordbatch" name = "common-recordbatch"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arc-swap", "arc-swap",
"common-base", "common-base",
@@ -2543,7 +2540,7 @@ dependencies = [
[[package]] [[package]]
name = "common-runtime" name = "common-runtime"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"clap 4.5.40", "clap 4.5.40",
@@ -2572,7 +2569,7 @@ dependencies = [
[[package]] [[package]]
name = "common-session" name = "common-session"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"serde", "serde",
"strum 0.27.1", "strum 0.27.1",
@@ -2580,14 +2577,12 @@ dependencies = [
[[package]] [[package]]
name = "common-sql" name = "common-sql"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arrow-schema",
"common-base", "common-base",
"common-decimal", "common-decimal",
"common-error", "common-error",
"common-macro", "common-macro",
"common-telemetry",
"common-time", "common-time",
"datafusion-sql", "datafusion-sql",
"datatypes", "datatypes",
@@ -2600,7 +2595,7 @@ dependencies = [
[[package]] [[package]]
name = "common-stat" name = "common-stat"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-base", "common-base",
"common-runtime", "common-runtime",
@@ -2615,7 +2610,7 @@ dependencies = [
[[package]] [[package]]
name = "common-telemetry" name = "common-telemetry"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"backtrace", "backtrace",
"common-base", "common-base",
@@ -2644,7 +2639,7 @@ dependencies = [
[[package]] [[package]]
name = "common-test-util" name = "common-test-util"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"client", "client",
"common-grpc", "common-grpc",
@@ -2657,7 +2652,7 @@ dependencies = [
[[package]] [[package]]
name = "common-time" name = "common-time"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arrow", "arrow",
"chrono", "chrono",
@@ -2675,7 +2670,7 @@ dependencies = [
[[package]] [[package]]
name = "common-version" name = "common-version"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"build-data", "build-data",
"cargo-manifest", "cargo-manifest",
@@ -2686,7 +2681,7 @@ dependencies = [
[[package]] [[package]]
name = "common-wal" name = "common-wal"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-base", "common-base",
"common-error", "common-error",
@@ -2709,7 +2704,7 @@ dependencies = [
[[package]] [[package]]
name = "common-workload" name = "common-workload"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"common-telemetry", "common-telemetry",
"serde", "serde",
@@ -4017,7 +4012,7 @@ dependencies = [
[[package]] [[package]]
name = "datanode" name = "datanode"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arrow-flight", "arrow-flight",
@@ -4062,7 +4057,6 @@ dependencies = [
"mito2", "mito2",
"num_cpus", "num_cpus",
"object-store", "object-store",
"partition",
"prometheus", "prometheus",
"prost 0.13.5", "prost 0.13.5",
"query", "query",
@@ -4082,7 +4076,7 @@ dependencies = [
[[package]] [[package]]
name = "datatypes" name = "datatypes"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arrow", "arrow",
"arrow-array", "arrow-array",
@@ -4639,9 +4633,8 @@ dependencies = [
[[package]] [[package]]
name = "etcd-client" name = "etcd-client"
version = "0.16.1" version = "0.15.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "git+https://github.com/GreptimeTeam/etcd-client?rev=f62df834f0cffda355eba96691fe1a9a332b75a7#f62df834f0cffda355eba96691fe1a9a332b75a7"
checksum = "88365f1a5671eb2f7fc240adb216786bc6494b38ce15f1d26ad6eaa303d5e822"
dependencies = [ dependencies = [
"http 1.3.1", "http 1.3.1",
"prost 0.13.5", "prost 0.13.5",
@@ -4757,7 +4750,7 @@ checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"
[[package]] [[package]]
name = "file-engine" name = "file-engine"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -4889,7 +4882,7 @@ checksum = "8bf7cc16383c4b8d58b9905a8509f02926ce3058053c056376248d958c9df1e8"
[[package]] [[package]]
name = "flow" name = "flow"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arrow", "arrow",
@@ -4958,7 +4951,7 @@ dependencies = [
"sql", "sql",
"store-api", "store-api",
"strum 0.27.1", "strum 0.27.1",
"substrait 1.0.0-beta.4", "substrait 1.0.0-beta.2",
"table", "table",
"tokio", "tokio",
"tonic 0.13.1", "tonic 0.13.1",
@@ -5019,7 +5012,7 @@ checksum = "28dd6caf6059519a65843af8fe2a3ae298b14b80179855aeb4adc2c1934ee619"
[[package]] [[package]]
name = "frontend" name = "frontend"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arc-swap", "arc-swap",
@@ -5041,7 +5034,6 @@ dependencies = [
"common-function", "common-function",
"common-grpc", "common-grpc",
"common-macro", "common-macro",
"common-memory-manager",
"common-meta", "common-meta",
"common-options", "common-options",
"common-procedure", "common-procedure",
@@ -5467,7 +5459,7 @@ dependencies = [
[[package]] [[package]]
name = "greptime-proto" name = "greptime-proto"
version = "0.1.0" version = "0.1.0"
source = "git+https://github.com/GreptimeTeam/greptime-proto.git?rev=0e316b86d765e4718d6f0ca77b1ad179f222b822#0e316b86d765e4718d6f0ca77b1ad179f222b822" source = "git+https://github.com/GreptimeTeam/greptime-proto.git?rev=0423fa30203187c75e2937a668df1da699c8b96c#0423fa30203187c75e2937a668df1da699c8b96c"
dependencies = [ dependencies = [
"prost 0.13.5", "prost 0.13.5",
"prost-types 0.13.5", "prost-types 0.13.5",
@@ -6235,7 +6227,7 @@ dependencies = [
[[package]] [[package]]
name = "index" name = "index"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"asynchronous-codec", "asynchronous-codec",
@@ -7176,7 +7168,7 @@ checksum = "13dc2df351e3202783a1fe0d44375f7295ffb4049267b0f3018346dc122a1d94"
[[package]] [[package]]
name = "log-query" name = "log-query"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"chrono", "chrono",
"common-error", "common-error",
@@ -7188,7 +7180,7 @@ dependencies = [
[[package]] [[package]]
name = "log-store" name = "log-store"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-stream", "async-stream",
"async-trait", "async-trait",
@@ -7489,7 +7481,7 @@ dependencies = [
[[package]] [[package]]
name = "meta-client" name = "meta-client"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -7517,7 +7509,7 @@ dependencies = [
[[package]] [[package]]
name = "meta-srv" name = "meta-srv"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -7617,7 +7609,7 @@ dependencies = [
[[package]] [[package]]
name = "metric-engine" name = "metric-engine"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"aquamarine", "aquamarine",
@@ -7625,7 +7617,6 @@ dependencies = [
"async-trait", "async-trait",
"base64 0.22.1", "base64 0.22.1",
"bytes", "bytes",
"chrono",
"common-base", "common-base",
"common-error", "common-error",
"common-macro", "common-macro",
@@ -7715,7 +7706,7 @@ dependencies = [
[[package]] [[package]]
name = "mito-codec" name = "mito-codec"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"bytes", "bytes",
@@ -7740,7 +7731,7 @@ dependencies = [
[[package]] [[package]]
name = "mito2" name = "mito2"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"aquamarine", "aquamarine",
@@ -7780,6 +7771,7 @@ dependencies = [
"either", "either",
"futures", "futures",
"greptime-proto", "greptime-proto",
"humantime",
"humantime-serde", "humantime-serde",
"index", "index",
"itertools 0.14.0", "itertools 0.14.0",
@@ -7798,7 +7790,6 @@ dependencies = [
"rand 0.9.1", "rand 0.9.1",
"rayon", "rayon",
"regex", "regex",
"roaring",
"rskafka", "rskafka",
"rstest", "rstest",
"rstest_reuse", "rstest_reuse",
@@ -7817,7 +7808,6 @@ dependencies = [
"tokio-util", "tokio-util",
"toml 0.8.23", "toml 0.8.23",
"tracing", "tracing",
"usearch",
"uuid", "uuid",
] ]
@@ -8481,7 +8471,7 @@ dependencies = [
[[package]] [[package]]
name = "object-store" name = "object-store"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"bytes", "bytes",
@@ -8766,7 +8756,7 @@ dependencies = [
[[package]] [[package]]
name = "operator" name = "operator"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"api", "api",
@@ -8826,7 +8816,7 @@ dependencies = [
"sql", "sql",
"sqlparser", "sqlparser",
"store-api", "store-api",
"substrait 1.0.0-beta.4", "substrait 1.0.0-beta.2",
"table", "table",
"tokio", "tokio",
"tokio-util", "tokio-util",
@@ -9112,7 +9102,7 @@ dependencies = [
[[package]] [[package]]
name = "partition" name = "partition"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -9328,9 +9318,9 @@ dependencies = [
[[package]] [[package]]
name = "pgwire" name = "pgwire"
version = "0.37.0" version = "0.36.3"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "02d86d57e732d40382ceb9bfea80901d839bae8571aa11c06af9177aed9dfb6c" checksum = "70a2bcdcc4b20a88e0648778ecf00415bbd5b447742275439c22176835056f99"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"base64 0.22.1", "base64 0.22.1",
@@ -9349,7 +9339,6 @@ dependencies = [
"ryu", "ryu",
"serde", "serde",
"serde_json", "serde_json",
"smol_str",
"stringprep", "stringprep",
"thiserror 2.0.17", "thiserror 2.0.17",
"tokio", "tokio",
@@ -9470,12 +9459,11 @@ checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184"
[[package]] [[package]]
name = "pipeline" name = "pipeline"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"api", "api",
"arrow", "arrow",
"arrow-schema",
"async-trait", "async-trait",
"catalog", "catalog",
"chrono", "chrono",
@@ -9627,7 +9615,7 @@ dependencies = [
[[package]] [[package]]
name = "plugins" name = "plugins"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"auth", "auth",
"catalog", "catalog",
@@ -9929,7 +9917,7 @@ dependencies = [
[[package]] [[package]]
name = "promql" name = "promql"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"async-trait", "async-trait",
@@ -9953,9 +9941,9 @@ dependencies = [
[[package]] [[package]]
name = "promql-parser" name = "promql-parser"
version = "0.7.1" version = "0.6.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6c3c2199b84e1253aade469e92ae16cd8dbe1de031c66a00f4f5cdd650290a86" checksum = "328fe69c2443ec4f8e6c33ea925dde04a1026e6c95928e89ed02343944cac9bf"
dependencies = [ dependencies = [
"cfgrammar", "cfgrammar",
"chrono", "chrono",
@@ -9965,6 +9953,7 @@ dependencies = [
"regex", "regex",
"serde", "serde",
"serde_json", "serde_json",
"unescaper",
] ]
[[package]] [[package]]
@@ -10211,7 +10200,7 @@ dependencies = [
[[package]] [[package]]
name = "puffin" name = "puffin"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-compression 0.4.19", "async-compression 0.4.19",
"async-trait", "async-trait",
@@ -10253,7 +10242,7 @@ dependencies = [
[[package]] [[package]]
name = "query" name = "query"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"api", "api",
@@ -10320,11 +10309,12 @@ dependencies = [
"sql", "sql",
"sqlparser", "sqlparser",
"store-api", "store-api",
"substrait 1.0.0-beta.4", "substrait 1.0.0-beta.2",
"table", "table",
"tokio", "tokio",
"tokio-stream", "tokio-stream",
"tracing", "tracing",
"unescaper",
"uuid", "uuid",
] ]
@@ -11513,11 +11503,10 @@ checksum = "1bc711410fbe7399f390ca1c3b60ad0f53f80e95c5eb935e52268a0e2cd49acc"
[[package]] [[package]]
name = "serde" name = "serde"
version = "1.0.228" version = "1.0.219"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6"
dependencies = [ dependencies = [
"serde_core",
"serde_derive", "serde_derive",
] ]
@@ -11531,20 +11520,11 @@ dependencies = [
"serde", "serde",
] ]
[[package]]
name = "serde_core"
version = "1.0.228"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
dependencies = [
"serde_derive",
]
[[package]] [[package]]
name = "serde_derive" name = "serde_derive"
version = "1.0.228" version = "1.0.219"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@@ -11671,7 +11651,7 @@ dependencies = [
[[package]] [[package]]
name = "servers" name = "servers"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"api", "api",
@@ -11697,7 +11677,6 @@ dependencies = [
"common-grpc", "common-grpc",
"common-macro", "common-macro",
"common-mem-prof", "common-mem-prof",
"common-memory-manager",
"common-meta", "common-meta",
"common-plugins", "common-plugins",
"common-pprof", "common-pprof",
@@ -11800,7 +11779,7 @@ dependencies = [
[[package]] [[package]]
name = "session" name = "session"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"ahash 0.8.12", "ahash 0.8.12",
"api", "api",
@@ -12020,16 +11999,6 @@ dependencies = [
"serde", "serde",
] ]
[[package]]
name = "smol_str"
version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3498b0a27f93ef1402f20eefacfaa1691272ac4eca1cdc8c596cb0a245d6cbf5"
dependencies = [
"borsh",
"serde_core",
]
[[package]] [[package]]
name = "snafu" name = "snafu"
version = "0.7.5" version = "0.7.5"
@@ -12144,7 +12113,7 @@ dependencies = [
[[package]] [[package]]
name = "sql" name = "sql"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arrow-buffer", "arrow-buffer",
@@ -12204,7 +12173,7 @@ dependencies = [
[[package]] [[package]]
name = "sqlness-runner" name = "sqlness-runner"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"clap 4.5.40", "clap 4.5.40",
@@ -12235,7 +12204,7 @@ dependencies = [
[[package]] [[package]]
name = "sqlparser" name = "sqlparser"
version = "0.58.0" version = "0.58.0"
source = "git+https://github.com/GreptimeTeam/sqlparser-rs.git?rev=a0ce2bc6eb3e804532932f39833c32432f5c9a39#a0ce2bc6eb3e804532932f39833c32432f5c9a39" source = "git+https://github.com/GreptimeTeam/sqlparser-rs.git?rev=4b519a5caa95472cc3988f5556813a583dd35af1#4b519a5caa95472cc3988f5556813a583dd35af1"
dependencies = [ dependencies = [
"lazy_static", "lazy_static",
"log", "log",
@@ -12259,7 +12228,7 @@ dependencies = [
[[package]] [[package]]
name = "sqlparser_derive" name = "sqlparser_derive"
version = "0.3.0" version = "0.3.0"
source = "git+https://github.com/GreptimeTeam/sqlparser-rs.git?rev=a0ce2bc6eb3e804532932f39833c32432f5c9a39#a0ce2bc6eb3e804532932f39833c32432f5c9a39" source = "git+https://github.com/GreptimeTeam/sqlparser-rs.git?rev=4b519a5caa95472cc3988f5556813a583dd35af1#4b519a5caa95472cc3988f5556813a583dd35af1"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@@ -12481,7 +12450,7 @@ dependencies = [
[[package]] [[package]]
name = "standalone" name = "standalone"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"catalog", "catalog",
@@ -12490,7 +12459,6 @@ dependencies = [
"common-config", "common-config",
"common-error", "common-error",
"common-macro", "common-macro",
"common-memory-manager",
"common-meta", "common-meta",
"common-options", "common-options",
"common-procedure", "common-procedure",
@@ -12523,7 +12491,7 @@ checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f"
[[package]] [[package]]
name = "store-api" name = "store-api"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"aquamarine", "aquamarine",
@@ -12736,7 +12704,7 @@ dependencies = [
[[package]] [[package]]
name = "substrait" name = "substrait"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"bytes", "bytes",
@@ -12859,7 +12827,7 @@ dependencies = [
[[package]] [[package]]
name = "table" name = "table"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"async-trait", "async-trait",
@@ -13128,7 +13096,7 @@ checksum = "8f50febec83f5ee1df3015341d8bd429f2d1cc62bcba7ea2076759d315084683"
[[package]] [[package]]
name = "tests-fuzz" name = "tests-fuzz"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"arbitrary", "arbitrary",
"async-trait", "async-trait",
@@ -13172,7 +13140,7 @@ dependencies = [
[[package]] [[package]]
name = "tests-integration" name = "tests-integration"
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
dependencies = [ dependencies = [
"api", "api",
"arrow-flight", "arrow-flight",
@@ -13193,7 +13161,6 @@ dependencies = [
"common-event-recorder", "common-event-recorder",
"common-frontend", "common-frontend",
"common-grpc", "common-grpc",
"common-memory-manager",
"common-meta", "common-meta",
"common-procedure", "common-procedure",
"common-query", "common-query",
@@ -13248,7 +13215,7 @@ dependencies = [
"sqlx", "sqlx",
"standalone", "standalone",
"store-api", "store-api",
"substrait 1.0.0-beta.4", "substrait 1.0.0-beta.2",
"table", "table",
"tempfile", "tempfile",
"time", "time",
@@ -14167,6 +14134,15 @@ dependencies = [
"version_check", "version_check",
] ]
[[package]]
name = "unescaper"
version = "0.1.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c01d12e3a56a4432a8b436f293c25f4808bdf9e9f9f98f9260bba1f1bc5a1f26"
dependencies = [
"thiserror 2.0.17",
]
[[package]] [[package]]
name = "unicase" name = "unicase"
version = "2.8.1" version = "2.8.1"

View File

@@ -75,7 +75,7 @@ members = [
resolver = "2" resolver = "2"
[workspace.package] [workspace.package]
version = "1.0.0-beta.4" version = "1.0.0-beta.2"
edition = "2024" edition = "2024"
license = "Apache-2.0" license = "Apache-2.0"
@@ -103,7 +103,6 @@ aquamarine = "0.6"
arrow = { version = "56.2", features = ["prettyprint"] } arrow = { version = "56.2", features = ["prettyprint"] }
arrow-array = { version = "56.2", default-features = false, features = ["chrono-tz"] } arrow-array = { version = "56.2", default-features = false, features = ["chrono-tz"] }
arrow-buffer = "56.2" arrow-buffer = "56.2"
arrow-cast = "56.2"
arrow-flight = "56.2" arrow-flight = "56.2"
arrow-ipc = { version = "56.2", default-features = false, features = ["lz4", "zstd"] } arrow-ipc = { version = "56.2", default-features = false, features = ["lz4", "zstd"] }
arrow-schema = { version = "56.2", features = ["serde"] } arrow-schema = { version = "56.2", features = ["serde"] }
@@ -144,14 +143,14 @@ derive_builder = "0.20"
derive_more = { version = "2.1", features = ["full"] } derive_more = { version = "2.1", features = ["full"] }
dotenv = "0.15" dotenv = "0.15"
either = "1.15" either = "1.15"
etcd-client = { version = "0.16.1", features = [ etcd-client = { git = "https://github.com/GreptimeTeam/etcd-client", rev = "f62df834f0cffda355eba96691fe1a9a332b75a7", features = [
"tls", "tls",
"tls-roots", "tls-roots",
] } ] }
fst = "0.4.7" fst = "0.4.7"
futures = "0.3" futures = "0.3"
futures-util = "0.3" futures-util = "0.3"
greptime-proto = { git = "https://github.com/GreptimeTeam/greptime-proto.git", rev = "0e316b86d765e4718d6f0ca77b1ad179f222b822" } greptime-proto = { git = "https://github.com/GreptimeTeam/greptime-proto.git", rev = "0423fa30203187c75e2937a668df1da699c8b96c" }
hex = "0.4" hex = "0.4"
http = "1" http = "1"
humantime = "2.1" humantime = "2.1"
@@ -189,7 +188,7 @@ paste = "1.0"
pin-project = "1.0" pin-project = "1.0"
pretty_assertions = "1.4.0" pretty_assertions = "1.4.0"
prometheus = { version = "0.13.3", features = ["process"] } prometheus = { version = "0.13.3", features = ["process"] }
promql-parser = { version = "0.7.1", features = ["ser"] } promql-parser = { version = "0.6", features = ["ser"] }
prost = { version = "0.13", features = ["no-recursion-limit"] } prost = { version = "0.13", features = ["no-recursion-limit"] }
prost-types = "0.13" prost-types = "0.13"
raft-engine = { version = "0.4.1", default-features = false } raft-engine = { version = "0.4.1", default-features = false }
@@ -333,7 +332,7 @@ datafusion-physical-plan = { git = "https://github.com/GreptimeTeam/datafusion.g
datafusion-datasource = { git = "https://github.com/GreptimeTeam/datafusion.git", rev = "fd4b2abcf3c3e43e94951bda452c9fd35243aab0" } datafusion-datasource = { git = "https://github.com/GreptimeTeam/datafusion.git", rev = "fd4b2abcf3c3e43e94951bda452c9fd35243aab0" }
datafusion-sql = { git = "https://github.com/GreptimeTeam/datafusion.git", rev = "fd4b2abcf3c3e43e94951bda452c9fd35243aab0" } datafusion-sql = { git = "https://github.com/GreptimeTeam/datafusion.git", rev = "fd4b2abcf3c3e43e94951bda452c9fd35243aab0" }
datafusion-substrait = { git = "https://github.com/GreptimeTeam/datafusion.git", rev = "fd4b2abcf3c3e43e94951bda452c9fd35243aab0" } datafusion-substrait = { git = "https://github.com/GreptimeTeam/datafusion.git", rev = "fd4b2abcf3c3e43e94951bda452c9fd35243aab0" }
sqlparser = { git = "https://github.com/GreptimeTeam/sqlparser-rs.git", rev = "a0ce2bc6eb3e804532932f39833c32432f5c9a39" } # branch = "v0.58.x" sqlparser = { git = "https://github.com/GreptimeTeam/sqlparser-rs.git", rev = "4b519a5caa95472cc3988f5556813a583dd35af1" } # branch = "v0.58.x"
[profile.release] [profile.release]
debug = 1 debug = 1

View File

@@ -14,7 +14,6 @@ BUILDX_BUILDER_NAME ?= gtbuilder
BASE_IMAGE ?= ubuntu BASE_IMAGE ?= ubuntu
RUST_TOOLCHAIN ?= $(shell cat rust-toolchain.toml | grep channel | cut -d'"' -f2) RUST_TOOLCHAIN ?= $(shell cat rust-toolchain.toml | grep channel | cut -d'"' -f2)
CARGO_REGISTRY_CACHE ?= ${HOME}/.cargo/registry CARGO_REGISTRY_CACHE ?= ${HOME}/.cargo/registry
CARGO_GIT_CACHE ?= ${HOME}/.cargo/git
ARCH := $(shell uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/') ARCH := $(shell uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/')
OUTPUT_DIR := $(shell if [ "$(RELEASE)" = "true" ]; then echo "release"; elif [ ! -z "$(CARGO_PROFILE)" ]; then echo "$(CARGO_PROFILE)" ; else echo "debug"; fi) OUTPUT_DIR := $(shell if [ "$(RELEASE)" = "true" ]; then echo "release"; elif [ ! -z "$(CARGO_PROFILE)" ]; then echo "$(CARGO_PROFILE)" ; else echo "debug"; fi)
SQLNESS_OPTS ?= SQLNESS_OPTS ?=
@@ -87,7 +86,7 @@ build: ## Build debug version greptime.
build-by-dev-builder: ## Build greptime by dev-builder. build-by-dev-builder: ## Build greptime by dev-builder.
docker run --network=host \ docker run --network=host \
${ASSEMBLED_EXTRA_BUILD_ENV} \ ${ASSEMBLED_EXTRA_BUILD_ENV} \
-v ${PWD}:/greptimedb -v ${CARGO_REGISTRY_CACHE}:/root/.cargo/registry -v ${CARGO_GIT_CACHE}:/root/.cargo/git \ -v ${PWD}:/greptimedb -v ${CARGO_REGISTRY_CACHE}:/root/.cargo/registry \
-w /greptimedb ${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/dev-builder-${BASE_IMAGE}:${DEV_BUILDER_IMAGE_TAG} \ -w /greptimedb ${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/dev-builder-${BASE_IMAGE}:${DEV_BUILDER_IMAGE_TAG} \
make build \ make build \
CARGO_EXTENSION="${CARGO_EXTENSION}" \ CARGO_EXTENSION="${CARGO_EXTENSION}" \
@@ -101,7 +100,7 @@ build-by-dev-builder: ## Build greptime by dev-builder.
.PHONY: build-android-bin .PHONY: build-android-bin
build-android-bin: ## Build greptime binary for android. build-android-bin: ## Build greptime binary for android.
docker run --network=host \ docker run --network=host \
-v ${PWD}:/greptimedb -v ${CARGO_REGISTRY_CACHE}:/root/.cargo/registry -v ${CARGO_GIT_CACHE}:/root/.cargo/git \ -v ${PWD}:/greptimedb -v ${CARGO_REGISTRY_CACHE}:/root/.cargo/registry \
-w /greptimedb ${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/dev-builder-android:${DEV_BUILDER_IMAGE_TAG} \ -w /greptimedb ${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/dev-builder-android:${DEV_BUILDER_IMAGE_TAG} \
make build \ make build \
CARGO_EXTENSION="ndk --platform 23 -t aarch64-linux-android" \ CARGO_EXTENSION="ndk --platform 23 -t aarch64-linux-android" \
@@ -207,7 +206,7 @@ fix-udeps: ## Remove unused dependencies automatically.
@cargo udeps --workspace --all-targets --output json > udeps-report.json || true @cargo udeps --workspace --all-targets --output json > udeps-report.json || true
@echo "Removing unused dependencies..." @echo "Removing unused dependencies..."
@python3 scripts/fix-udeps.py udeps-report.json @python3 scripts/fix-udeps.py udeps-report.json
.PHONY: fmt-check .PHONY: fmt-check
fmt-check: ## Check code format. fmt-check: ## Check code format.
cargo fmt --all -- --check cargo fmt --all -- --check
@@ -225,7 +224,7 @@ stop-etcd: ## Stop single node etcd for testing purpose.
.PHONY: run-it-in-container .PHONY: run-it-in-container
run-it-in-container: start-etcd ## Run integration tests in dev-builder. run-it-in-container: start-etcd ## Run integration tests in dev-builder.
docker run --network=host \ docker run --network=host \
-v ${PWD}:/greptimedb -v ${CARGO_REGISTRY_CACHE}:/root/.cargo/registry -v ${CARGO_GIT_CACHE}:/root/.cargo/git -v /tmp:/tmp \ -v ${PWD}:/greptimedb -v ${CARGO_REGISTRY_CACHE}:/root/.cargo/registry -v /tmp:/tmp \
-w /greptimedb ${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/dev-builder-${BASE_IMAGE}:${DEV_BUILDER_IMAGE_TAG} \ -w /greptimedb ${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/dev-builder-${BASE_IMAGE}:${DEV_BUILDER_IMAGE_TAG} \
make test sqlness-test BUILD_JOBS=${BUILD_JOBS} make test sqlness-test BUILD_JOBS=${BUILD_JOBS}

View File

@@ -17,7 +17,7 @@ Release date: {{ timestamp | date(format="%B %d, %Y") }}
{%- set breakings = commits | filter(attribute="breaking", value=true) -%} {%- set breakings = commits | filter(attribute="breaking", value=true) -%}
{%- if breakings | length > 0 %} {%- if breakings | length > 0 %}
### Breaking changes ## Breaking changes
{% for commit in breakings %} {% for commit in breakings %}
* {{ commit.github.pr_title }}\ * {{ commit.github.pr_title }}\
{% if commit.github.username %} by \ {% if commit.github.username %} by \

View File

@@ -14,12 +14,11 @@
| --- | -----| ------- | ----------- | | --- | -----| ------- | ----------- |
| `default_timezone` | String | Unset | The default timezone of the server. | | `default_timezone` | String | Unset | The default timezone of the server. |
| `default_column_prefix` | String | Unset | The default column prefix for auto-created time index and value columns. | | `default_column_prefix` | String | Unset | The default column prefix for auto-created time index and value columns. |
| `max_in_flight_write_bytes` | String | Unset | Maximum total memory for all concurrent write request bodies and messages (HTTP, gRPC, Flight).<br/>Set to 0 to disable the limit. Default: "0" (unlimited) |
| `write_bytes_exhausted_policy` | String | Unset | Policy when write bytes quota is exhausted.<br/>Options: "wait" (default, 10s timeout), "wait(<duration>)" (e.g., "wait(30s)"), "fail" |
| `init_regions_in_background` | Bool | `false` | Initialize all regions in the background during the startup.<br/>By default, it provides services after all regions have been initialized. | | `init_regions_in_background` | Bool | `false` | Initialize all regions in the background during the startup.<br/>By default, it provides services after all regions have been initialized. |
| `init_regions_parallelism` | Integer | `16` | Parallelism of initializing regions. | | `init_regions_parallelism` | Integer | `16` | Parallelism of initializing regions. |
| `max_concurrent_queries` | Integer | `0` | The maximum current queries allowed to be executed. Zero means unlimited.<br/>NOTE: This setting affects scan_memory_limit's privileged tier allocation.<br/>When set, 70% of queries get privileged memory access (full scan_memory_limit).<br/>The remaining 30% get standard tier access (70% of scan_memory_limit). | | `max_concurrent_queries` | Integer | `0` | The maximum current queries allowed to be executed. Zero means unlimited.<br/>NOTE: This setting affects scan_memory_limit's privileged tier allocation.<br/>When set, 70% of queries get privileged memory access (full scan_memory_limit).<br/>The remaining 30% get standard tier access (70% of scan_memory_limit). |
| `enable_telemetry` | Bool | `true` | Enable telemetry to collect anonymous usage data. Enabled by default. | | `enable_telemetry` | Bool | `true` | Enable telemetry to collect anonymous usage data. Enabled by default. |
| `max_in_flight_write_bytes` | String | Unset | The maximum in-flight write bytes. |
| `runtime` | -- | -- | The runtime options. | | `runtime` | -- | -- | The runtime options. |
| `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. | | `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. |
| `runtime.compact_rt_size` | Integer | `4` | The number of threads to execute the runtime for global write operations. | | `runtime.compact_rt_size` | Integer | `4` | The number of threads to execute the runtime for global write operations. |
@@ -27,12 +26,14 @@
| `http.addr` | String | `127.0.0.1:4000` | The address to bind the HTTP server. | | `http.addr` | String | `127.0.0.1:4000` | The address to bind the HTTP server. |
| `http.timeout` | String | `0s` | HTTP request timeout. Set to 0 to disable timeout. | | `http.timeout` | String | `0s` | HTTP request timeout. Set to 0 to disable timeout. |
| `http.body_limit` | String | `64MB` | HTTP request body limit.<br/>The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`.<br/>Set to 0 to disable limit. | | `http.body_limit` | String | `64MB` | HTTP request body limit.<br/>The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`.<br/>Set to 0 to disable limit. |
| `http.max_total_body_memory` | String | Unset | Maximum total memory for all concurrent HTTP request bodies.<br/>Set to 0 to disable the limit. Default: "0" (unlimited) |
| `http.enable_cors` | Bool | `true` | HTTP CORS support, it's turned on by default<br/>This allows browser to access http APIs without CORS restrictions | | `http.enable_cors` | Bool | `true` | HTTP CORS support, it's turned on by default<br/>This allows browser to access http APIs without CORS restrictions |
| `http.cors_allowed_origins` | Array | Unset | Customize allowed origins for HTTP CORS. | | `http.cors_allowed_origins` | Array | Unset | Customize allowed origins for HTTP CORS. |
| `http.prom_validation_mode` | String | `strict` | Whether to enable validation for Prometheus remote write requests.<br/>Available options:<br/>- strict: deny invalid UTF-8 strings (default).<br/>- lossy: allow invalid UTF-8 strings, replace invalid characters with REPLACEMENT_CHARACTER(U+FFFD).<br/>- unchecked: do not valid strings. | | `http.prom_validation_mode` | String | `strict` | Whether to enable validation for Prometheus remote write requests.<br/>Available options:<br/>- strict: deny invalid UTF-8 strings (default).<br/>- lossy: allow invalid UTF-8 strings, replace invalid characters with REPLACEMENT_CHARACTER(U+FFFD).<br/>- unchecked: do not valid strings. |
| `grpc` | -- | -- | The gRPC server options. | | `grpc` | -- | -- | The gRPC server options. |
| `grpc.bind_addr` | String | `127.0.0.1:4001` | The address to bind the gRPC server. | | `grpc.bind_addr` | String | `127.0.0.1:4001` | The address to bind the gRPC server. |
| `grpc.runtime_size` | Integer | `8` | The number of server worker threads. | | `grpc.runtime_size` | Integer | `8` | The number of server worker threads. |
| `grpc.max_total_message_memory` | String | Unset | Maximum total memory for all concurrent gRPC request messages.<br/>Set to 0 to disable the limit. Default: "0" (unlimited) |
| `grpc.max_connection_age` | String | Unset | The maximum connection age for gRPC connection.<br/>The value can be a human-readable time string. For example: `10m` for ten minutes or `1h` for one hour.<br/>Refer to https://grpc.io/docs/guides/keepalive/ for more details. | | `grpc.max_connection_age` | String | Unset | The maximum connection age for gRPC connection.<br/>The value can be a human-readable time string. For example: `10m` for ten minutes or `1h` for one hour.<br/>Refer to https://grpc.io/docs/guides/keepalive/ for more details. |
| `grpc.tls` | -- | -- | gRPC server TLS options, see `mysql.tls` section. | | `grpc.tls` | -- | -- | gRPC server TLS options, see `mysql.tls` section. |
| `grpc.tls.mode` | String | `disable` | TLS mode. | | `grpc.tls.mode` | String | `disable` | TLS mode. |
@@ -82,8 +83,6 @@
| `wal.sync_period` | String | `10s` | Duration for fsyncing log files.<br/>**It's only used when the provider is `raft_engine`**. | | `wal.sync_period` | String | `10s` | Duration for fsyncing log files.<br/>**It's only used when the provider is `raft_engine`**. |
| `wal.recovery_parallelism` | Integer | `2` | Parallelism during WAL recovery. | | `wal.recovery_parallelism` | Integer | `2` | Parallelism during WAL recovery. |
| `wal.broker_endpoints` | Array | -- | The Kafka broker endpoints.<br/>**It's only used when the provider is `kafka`**. | | `wal.broker_endpoints` | Array | -- | The Kafka broker endpoints.<br/>**It's only used when the provider is `kafka`**. |
| `wal.connect_timeout` | String | `3s` | The connect timeout for kafka client.<br/>**It's only used when the provider is `kafka`**. |
| `wal.timeout` | String | `3s` | The timeout for kafka client.<br/>**It's only used when the provider is `kafka`**. |
| `wal.auto_create_topics` | Bool | `true` | Automatically create topics for WAL.<br/>Set to `true` to automatically create topics for WAL.<br/>Otherwise, use topics named `topic_name_prefix_[0..num_topics)` | | `wal.auto_create_topics` | Bool | `true` | Automatically create topics for WAL.<br/>Set to `true` to automatically create topics for WAL.<br/>Otherwise, use topics named `topic_name_prefix_[0..num_topics)` |
| `wal.num_topics` | Integer | `64` | Number of topics.<br/>**It's only used when the provider is `kafka`**. | | `wal.num_topics` | Integer | `64` | Number of topics.<br/>**It's only used when the provider is `kafka`**. |
| `wal.selector_type` | String | `round_robin` | Topic selector type.<br/>Available selector types:<br/>- `round_robin` (default)<br/>**It's only used when the provider is `kafka`**. | | `wal.selector_type` | String | `round_robin` | Topic selector type.<br/>Available selector types:<br/>- `round_robin` (default)<br/>**It's only used when the provider is `kafka`**. |
@@ -226,8 +225,7 @@
| --- | -----| ------- | ----------- | | --- | -----| ------- | ----------- |
| `default_timezone` | String | Unset | The default timezone of the server. | | `default_timezone` | String | Unset | The default timezone of the server. |
| `default_column_prefix` | String | Unset | The default column prefix for auto-created time index and value columns. | | `default_column_prefix` | String | Unset | The default column prefix for auto-created time index and value columns. |
| `max_in_flight_write_bytes` | String | Unset | Maximum total memory for all concurrent write request bodies and messages (HTTP, gRPC, Flight).<br/>Set to 0 to disable the limit. Default: "0" (unlimited) | | `max_in_flight_write_bytes` | String | Unset | The maximum in-flight write bytes. |
| `write_bytes_exhausted_policy` | String | Unset | Policy when write bytes quota is exhausted.<br/>Options: "wait" (default, 10s timeout), "wait(<duration>)" (e.g., "wait(30s)"), "fail" |
| `runtime` | -- | -- | The runtime options. | | `runtime` | -- | -- | The runtime options. |
| `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. | | `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. |
| `runtime.compact_rt_size` | Integer | `4` | The number of threads to execute the runtime for global write operations. | | `runtime.compact_rt_size` | Integer | `4` | The number of threads to execute the runtime for global write operations. |
@@ -238,6 +236,7 @@
| `http.addr` | String | `127.0.0.1:4000` | The address to bind the HTTP server. | | `http.addr` | String | `127.0.0.1:4000` | The address to bind the HTTP server. |
| `http.timeout` | String | `0s` | HTTP request timeout. Set to 0 to disable timeout. | | `http.timeout` | String | `0s` | HTTP request timeout. Set to 0 to disable timeout. |
| `http.body_limit` | String | `64MB` | HTTP request body limit.<br/>The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`.<br/>Set to 0 to disable limit. | | `http.body_limit` | String | `64MB` | HTTP request body limit.<br/>The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`.<br/>Set to 0 to disable limit. |
| `http.max_total_body_memory` | String | Unset | Maximum total memory for all concurrent HTTP request bodies.<br/>Set to 0 to disable the limit. Default: "0" (unlimited) |
| `http.enable_cors` | Bool | `true` | HTTP CORS support, it's turned on by default<br/>This allows browser to access http APIs without CORS restrictions | | `http.enable_cors` | Bool | `true` | HTTP CORS support, it's turned on by default<br/>This allows browser to access http APIs without CORS restrictions |
| `http.cors_allowed_origins` | Array | Unset | Customize allowed origins for HTTP CORS. | | `http.cors_allowed_origins` | Array | Unset | Customize allowed origins for HTTP CORS. |
| `http.prom_validation_mode` | String | `strict` | Whether to enable validation for Prometheus remote write requests.<br/>Available options:<br/>- strict: deny invalid UTF-8 strings (default).<br/>- lossy: allow invalid UTF-8 strings, replace invalid characters with REPLACEMENT_CHARACTER(U+FFFD).<br/>- unchecked: do not valid strings. | | `http.prom_validation_mode` | String | `strict` | Whether to enable validation for Prometheus remote write requests.<br/>Available options:<br/>- strict: deny invalid UTF-8 strings (default).<br/>- lossy: allow invalid UTF-8 strings, replace invalid characters with REPLACEMENT_CHARACTER(U+FFFD).<br/>- unchecked: do not valid strings. |
@@ -245,6 +244,7 @@
| `grpc.bind_addr` | String | `127.0.0.1:4001` | The address to bind the gRPC server. | | `grpc.bind_addr` | String | `127.0.0.1:4001` | The address to bind the gRPC server. |
| `grpc.server_addr` | String | `127.0.0.1:4001` | The address advertised to the metasrv, and used for connections from outside the host.<br/>If left empty or unset, the server will automatically use the IP address of the first network interface<br/>on the host, with the same port number as the one specified in `grpc.bind_addr`. | | `grpc.server_addr` | String | `127.0.0.1:4001` | The address advertised to the metasrv, and used for connections from outside the host.<br/>If left empty or unset, the server will automatically use the IP address of the first network interface<br/>on the host, with the same port number as the one specified in `grpc.bind_addr`. |
| `grpc.runtime_size` | Integer | `8` | The number of server worker threads. | | `grpc.runtime_size` | Integer | `8` | The number of server worker threads. |
| `grpc.max_total_message_memory` | String | Unset | Maximum total memory for all concurrent gRPC request messages.<br/>Set to 0 to disable the limit. Default: "0" (unlimited) |
| `grpc.flight_compression` | String | `arrow_ipc` | Compression mode for frontend side Arrow IPC service. Available options:<br/>- `none`: disable all compression<br/>- `transport`: only enable gRPC transport compression (zstd)<br/>- `arrow_ipc`: only enable Arrow IPC compression (lz4)<br/>- `all`: enable all compression.<br/>Default to `none` | | `grpc.flight_compression` | String | `arrow_ipc` | Compression mode for frontend side Arrow IPC service. Available options:<br/>- `none`: disable all compression<br/>- `transport`: only enable gRPC transport compression (zstd)<br/>- `arrow_ipc`: only enable Arrow IPC compression (lz4)<br/>- `all`: enable all compression.<br/>Default to `none` |
| `grpc.max_connection_age` | String | Unset | The maximum connection age for gRPC connection.<br/>The value can be a human-readable time string. For example: `10m` for ten minutes or `1h` for one hour.<br/>Refer to https://grpc.io/docs/guides/keepalive/ for more details. | | `grpc.max_connection_age` | String | Unset | The maximum connection age for gRPC connection.<br/>The value can be a human-readable time string. For example: `10m` for ten minutes or `1h` for one hour.<br/>Refer to https://grpc.io/docs/guides/keepalive/ for more details. |
| `grpc.tls` | -- | -- | gRPC server TLS options, see `mysql.tls` section. | | `grpc.tls` | -- | -- | gRPC server TLS options, see `mysql.tls` section. |
@@ -344,15 +344,14 @@
| `store_key_prefix` | String | `""` | If it's not empty, the metasrv will store all data with this key prefix. | | `store_key_prefix` | String | `""` | If it's not empty, the metasrv will store all data with this key prefix. |
| `backend` | String | `etcd_store` | The datastore for meta server.<br/>Available values:<br/>- `etcd_store` (default value)<br/>- `memory_store`<br/>- `postgres_store`<br/>- `mysql_store` | | `backend` | String | `etcd_store` | The datastore for meta server.<br/>Available values:<br/>- `etcd_store` (default value)<br/>- `memory_store`<br/>- `postgres_store`<br/>- `mysql_store` |
| `meta_table_name` | String | `greptime_metakv` | Table name in RDS to store metadata. Effect when using a RDS kvbackend.<br/>**Only used when backend is `postgres_store`.** | | `meta_table_name` | String | `greptime_metakv` | Table name in RDS to store metadata. Effect when using a RDS kvbackend.<br/>**Only used when backend is `postgres_store`.** |
| `meta_schema_name` | String | `greptime_schema` | Optional PostgreSQL schema for metadata table and election table name qualification.<br/>When PostgreSQL public schema is not writable (e.g., PostgreSQL 15+ with restricted public),<br/>set this to a writable schema. GreptimeDB will use `meta_schema_name`.`meta_table_name`.<br/>**Only used when backend is `postgres_store`.** | | `meta_schema_name` | String | `greptime_schema` | Optional PostgreSQL schema for metadata table and election table name qualification.<br/>When PostgreSQL public schema is not writable (e.g., PostgreSQL 15+ with restricted public),<br/>set this to a writable schema. GreptimeDB will use `meta_schema_name`.`meta_table_name`.<br/>GreptimeDB will NOT create the schema automatically; please ensure it exists or the user has permission.<br/>**Only used when backend is `postgres_store`.** |
| `auto_create_schema` | Bool | `true` | Automatically create PostgreSQL schema if it doesn't exist.<br/>When enabled, the system will execute `CREATE SCHEMA IF NOT EXISTS <schema_name>`<br/>before creating metadata tables. This is useful in production environments where<br/>manual schema creation may be restricted.<br/>Default is true.<br/>Note: The PostgreSQL user must have CREATE SCHEMA permission for this to work.<br/>**Only used when backend is `postgres_store`.** |
| `meta_election_lock_id` | Integer | `1` | Advisory lock id in PostgreSQL for election. Effect when using PostgreSQL as kvbackend<br/>Only used when backend is `postgres_store`. | | `meta_election_lock_id` | Integer | `1` | Advisory lock id in PostgreSQL for election. Effect when using PostgreSQL as kvbackend<br/>Only used when backend is `postgres_store`. |
| `selector` | String | `round_robin` | Datanode selector type.<br/>- `round_robin` (default value)<br/>- `lease_based`<br/>- `load_based`<br/>For details, please see "https://docs.greptime.com/developer-guide/metasrv/selector". | | `selector` | String | `round_robin` | Datanode selector type.<br/>- `round_robin` (default value)<br/>- `lease_based`<br/>- `load_based`<br/>For details, please see "https://docs.greptime.com/developer-guide/metasrv/selector". |
| `use_memory_store` | Bool | `false` | Store data in memory. |
| `enable_region_failover` | Bool | `false` | Whether to enable region failover.<br/>This feature is only available on GreptimeDB running on cluster mode and<br/>- Using Remote WAL<br/>- Using shared storage (e.g., s3). | | `enable_region_failover` | Bool | `false` | Whether to enable region failover.<br/>This feature is only available on GreptimeDB running on cluster mode and<br/>- Using Remote WAL<br/>- Using shared storage (e.g., s3). |
| `region_failure_detector_initialization_delay` | String | `10m` | The delay before starting region failure detection.<br/>This delay helps prevent Metasrv from triggering unnecessary region failovers before all Datanodes are fully started.<br/>Especially useful when the cluster is not deployed with GreptimeDB Operator and maintenance mode is not enabled. | | `region_failure_detector_initialization_delay` | String | `10m` | The delay before starting region failure detection.<br/>This delay helps prevent Metasrv from triggering unnecessary region failovers before all Datanodes are fully started.<br/>Especially useful when the cluster is not deployed with GreptimeDB Operator and maintenance mode is not enabled. |
| `allow_region_failover_on_local_wal` | Bool | `false` | Whether to allow region failover on local WAL.<br/>**This option is not recommended to be set to true, because it may lead to data loss during failover.** | | `allow_region_failover_on_local_wal` | Bool | `false` | Whether to allow region failover on local WAL.<br/>**This option is not recommended to be set to true, because it may lead to data loss during failover.** |
| `node_max_idle_time` | String | `24hours` | Max allowed idle time before removing node info from metasrv memory. | | `node_max_idle_time` | String | `24hours` | Max allowed idle time before removing node info from metasrv memory. |
| `heartbeat_interval` | String | `3s` | Base heartbeat interval for calculating distributed time constants.<br/>The frontend heartbeat interval is 6 times of the base heartbeat interval.<br/>The flownode/datanode heartbeat interval is 1 times of the base heartbeat interval.<br/>e.g., If the base heartbeat interval is 3s, the frontend heartbeat interval is 18s, the flownode/datanode heartbeat interval is 3s.<br/>If you change this value, you need to change the heartbeat interval of the flownode/frontend/datanode accordingly. |
| `enable_telemetry` | Bool | `true` | Whether to enable greptimedb telemetry. Enabled by default. | | `enable_telemetry` | Bool | `true` | Whether to enable greptimedb telemetry. Enabled by default. |
| `runtime` | -- | -- | The runtime options. | | `runtime` | -- | -- | The runtime options. |
| `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. | | `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. |
@@ -362,18 +361,12 @@
| `backend_tls.cert_path` | String | `""` | Path to client certificate file (for client authentication)<br/>Like "/path/to/client.crt" | | `backend_tls.cert_path` | String | `""` | Path to client certificate file (for client authentication)<br/>Like "/path/to/client.crt" |
| `backend_tls.key_path` | String | `""` | Path to client private key file (for client authentication)<br/>Like "/path/to/client.key" | | `backend_tls.key_path` | String | `""` | Path to client private key file (for client authentication)<br/>Like "/path/to/client.key" |
| `backend_tls.ca_cert_path` | String | `""` | Path to CA certificate file (for server certificate verification)<br/>Required when using custom CAs or self-signed certificates<br/>Leave empty to use system root certificates only<br/>Like "/path/to/ca.crt" | | `backend_tls.ca_cert_path` | String | `""` | Path to CA certificate file (for server certificate verification)<br/>Required when using custom CAs or self-signed certificates<br/>Leave empty to use system root certificates only<br/>Like "/path/to/ca.crt" |
| `backend_client` | -- | -- | The backend client options.<br/>Currently, only applicable when using etcd as the metadata store. |
| `backend_client.keep_alive_timeout` | String | `3s` | The keep alive timeout for backend client. |
| `backend_client.keep_alive_interval` | String | `10s` | The keep alive interval for backend client. |
| `backend_client.connect_timeout` | String | `3s` | The connect timeout for backend client. |
| `grpc` | -- | -- | The gRPC server options. | | `grpc` | -- | -- | The gRPC server options. |
| `grpc.bind_addr` | String | `127.0.0.1:3002` | The address to bind the gRPC server. | | `grpc.bind_addr` | String | `127.0.0.1:3002` | The address to bind the gRPC server. |
| `grpc.server_addr` | String | `127.0.0.1:3002` | The communication server address for the frontend and datanode to connect to metasrv.<br/>If left empty or unset, the server will automatically use the IP address of the first network interface<br/>on the host, with the same port number as the one specified in `bind_addr`. | | `grpc.server_addr` | String | `127.0.0.1:3002` | The communication server address for the frontend and datanode to connect to metasrv.<br/>If left empty or unset, the server will automatically use the IP address of the first network interface<br/>on the host, with the same port number as the one specified in `bind_addr`. |
| `grpc.runtime_size` | Integer | `8` | The number of server worker threads. | | `grpc.runtime_size` | Integer | `8` | The number of server worker threads. |
| `grpc.max_recv_message_size` | String | `512MB` | The maximum receive message size for gRPC server. | | `grpc.max_recv_message_size` | String | `512MB` | The maximum receive message size for gRPC server. |
| `grpc.max_send_message_size` | String | `512MB` | The maximum send message size for gRPC server. | | `grpc.max_send_message_size` | String | `512MB` | The maximum send message size for gRPC server. |
| `grpc.http2_keep_alive_interval` | String | `10s` | The server side HTTP/2 keep-alive interval |
| `grpc.http2_keep_alive_timeout` | String | `3s` | The server side HTTP/2 keep-alive timeout. |
| `http` | -- | -- | The HTTP server options. | | `http` | -- | -- | The HTTP server options. |
| `http.addr` | String | `127.0.0.1:4000` | The address to bind the HTTP server. | | `http.addr` | String | `127.0.0.1:4000` | The address to bind the HTTP server. |
| `http.timeout` | String | `0s` | HTTP request timeout. Set to 0 to disable timeout. | | `http.timeout` | String | `0s` | HTTP request timeout. Set to 0 to disable timeout. |
@@ -483,8 +476,6 @@
| `wal.sync_period` | String | `10s` | Duration for fsyncing log files.<br/>**It's only used when the provider is `raft_engine`**. | | `wal.sync_period` | String | `10s` | Duration for fsyncing log files.<br/>**It's only used when the provider is `raft_engine`**. |
| `wal.recovery_parallelism` | Integer | `2` | Parallelism during WAL recovery. | | `wal.recovery_parallelism` | Integer | `2` | Parallelism during WAL recovery. |
| `wal.broker_endpoints` | Array | -- | The Kafka broker endpoints.<br/>**It's only used when the provider is `kafka`**. | | `wal.broker_endpoints` | Array | -- | The Kafka broker endpoints.<br/>**It's only used when the provider is `kafka`**. |
| `wal.connect_timeout` | String | `3s` | The connect timeout for kafka client.<br/>**It's only used when the provider is `kafka`**. |
| `wal.timeout` | String | `3s` | The timeout for kafka client.<br/>**It's only used when the provider is `kafka`**. |
| `wal.max_batch_bytes` | String | `1MB` | The max size of a single producer batch.<br/>Warning: Kafka has a default limit of 1MB per message in a topic.<br/>**It's only used when the provider is `kafka`**. | | `wal.max_batch_bytes` | String | `1MB` | The max size of a single producer batch.<br/>Warning: Kafka has a default limit of 1MB per message in a topic.<br/>**It's only used when the provider is `kafka`**. |
| `wal.consumer_wait_timeout` | String | `100ms` | The consumer wait timeout.<br/>**It's only used when the provider is `kafka`**. | | `wal.consumer_wait_timeout` | String | `100ms` | The consumer wait timeout.<br/>**It's only used when the provider is `kafka`**. |
| `wal.create_index` | Bool | `true` | Whether to enable WAL index creation.<br/>**It's only used when the provider is `kafka`**. | | `wal.create_index` | Bool | `true` | Whether to enable WAL index creation.<br/>**It's only used when the provider is `kafka`**. |

View File

@@ -169,14 +169,6 @@ recovery_parallelism = 2
## **It's only used when the provider is `kafka`**. ## **It's only used when the provider is `kafka`**.
broker_endpoints = ["127.0.0.1:9092"] broker_endpoints = ["127.0.0.1:9092"]
## The connect timeout for kafka client.
## **It's only used when the provider is `kafka`**.
#+ connect_timeout = "3s"
## The timeout for kafka client.
## **It's only used when the provider is `kafka`**.
#+ timeout = "3s"
## The max size of a single producer batch. ## The max size of a single producer batch.
## Warning: Kafka has a default limit of 1MB per message in a topic. ## Warning: Kafka has a default limit of 1MB per message in a topic.
## **It's only used when the provider is `kafka`**. ## **It's only used when the provider is `kafka`**.
@@ -233,7 +225,6 @@ overwrite_entry_start_id = false
# endpoint = "https://s3.amazonaws.com" # endpoint = "https://s3.amazonaws.com"
# region = "us-west-2" # region = "us-west-2"
# enable_virtual_host_style = false # enable_virtual_host_style = false
# disable_ec2_metadata = false
# Example of using Oss as the storage. # Example of using Oss as the storage.
# [storage] # [storage]

View File

@@ -6,15 +6,9 @@ default_timezone = "UTC"
## @toml2docs:none-default ## @toml2docs:none-default
default_column_prefix = "greptime" default_column_prefix = "greptime"
## Maximum total memory for all concurrent write request bodies and messages (HTTP, gRPC, Flight). ## The maximum in-flight write bytes.
## Set to 0 to disable the limit. Default: "0" (unlimited)
## @toml2docs:none-default ## @toml2docs:none-default
#+ max_in_flight_write_bytes = "1GB" #+ max_in_flight_write_bytes = "500MB"
## Policy when write bytes quota is exhausted.
## Options: "wait" (default, 10s timeout), "wait(<duration>)" (e.g., "wait(30s)"), "fail"
## @toml2docs:none-default
#+ write_bytes_exhausted_policy = "wait"
## The runtime options. ## The runtime options.
#+ [runtime] #+ [runtime]
@@ -41,6 +35,10 @@ timeout = "0s"
## The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`. ## The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`.
## Set to 0 to disable limit. ## Set to 0 to disable limit.
body_limit = "64MB" body_limit = "64MB"
## Maximum total memory for all concurrent HTTP request bodies.
## Set to 0 to disable the limit. Default: "0" (unlimited)
## @toml2docs:none-default
#+ max_total_body_memory = "1GB"
## HTTP CORS support, it's turned on by default ## HTTP CORS support, it's turned on by default
## This allows browser to access http APIs without CORS restrictions ## This allows browser to access http APIs without CORS restrictions
enable_cors = true enable_cors = true
@@ -64,6 +62,10 @@ bind_addr = "127.0.0.1:4001"
server_addr = "127.0.0.1:4001" server_addr = "127.0.0.1:4001"
## The number of server worker threads. ## The number of server worker threads.
runtime_size = 8 runtime_size = 8
## Maximum total memory for all concurrent gRPC request messages.
## Set to 0 to disable the limit. Default: "0" (unlimited)
## @toml2docs:none-default
#+ max_total_message_memory = "1GB"
## Compression mode for frontend side Arrow IPC service. Available options: ## Compression mode for frontend side Arrow IPC service. Available options:
## - `none`: disable all compression ## - `none`: disable all compression
## - `transport`: only enable gRPC transport compression (zstd) ## - `transport`: only enable gRPC transport compression (zstd)
@@ -129,6 +131,7 @@ key_path = ""
## For now, gRPC tls config does not support auto reload. ## For now, gRPC tls config does not support auto reload.
watch = false watch = false
## MySQL server options. ## MySQL server options.
[mysql] [mysql]
## Whether to enable. ## Whether to enable.

View File

@@ -34,17 +34,10 @@ meta_table_name = "greptime_metakv"
## Optional PostgreSQL schema for metadata table and election table name qualification. ## Optional PostgreSQL schema for metadata table and election table name qualification.
## When PostgreSQL public schema is not writable (e.g., PostgreSQL 15+ with restricted public), ## When PostgreSQL public schema is not writable (e.g., PostgreSQL 15+ with restricted public),
## set this to a writable schema. GreptimeDB will use `meta_schema_name`.`meta_table_name`. ## set this to a writable schema. GreptimeDB will use `meta_schema_name`.`meta_table_name`.
## GreptimeDB will NOT create the schema automatically; please ensure it exists or the user has permission.
## **Only used when backend is `postgres_store`.** ## **Only used when backend is `postgres_store`.**
meta_schema_name = "greptime_schema"
## Automatically create PostgreSQL schema if it doesn't exist. meta_schema_name = "greptime_schema"
## When enabled, the system will execute `CREATE SCHEMA IF NOT EXISTS <schema_name>`
## before creating metadata tables. This is useful in production environments where
## manual schema creation may be restricted.
## Default is true.
## Note: The PostgreSQL user must have CREATE SCHEMA permission for this to work.
## **Only used when backend is `postgres_store`.**
auto_create_schema = true
## Advisory lock id in PostgreSQL for election. Effect when using PostgreSQL as kvbackend ## Advisory lock id in PostgreSQL for election. Effect when using PostgreSQL as kvbackend
## Only used when backend is `postgres_store`. ## Only used when backend is `postgres_store`.
@@ -57,6 +50,9 @@ meta_election_lock_id = 1
## For details, please see "https://docs.greptime.com/developer-guide/metasrv/selector". ## For details, please see "https://docs.greptime.com/developer-guide/metasrv/selector".
selector = "round_robin" selector = "round_robin"
## Store data in memory.
use_memory_store = false
## Whether to enable region failover. ## Whether to enable region failover.
## This feature is only available on GreptimeDB running on cluster mode and ## This feature is only available on GreptimeDB running on cluster mode and
## - Using Remote WAL ## - Using Remote WAL
@@ -75,13 +71,6 @@ allow_region_failover_on_local_wal = false
## Max allowed idle time before removing node info from metasrv memory. ## Max allowed idle time before removing node info from metasrv memory.
node_max_idle_time = "24hours" node_max_idle_time = "24hours"
## Base heartbeat interval for calculating distributed time constants.
## The frontend heartbeat interval is 6 times of the base heartbeat interval.
## The flownode/datanode heartbeat interval is 1 times of the base heartbeat interval.
## e.g., If the base heartbeat interval is 3s, the frontend heartbeat interval is 18s, the flownode/datanode heartbeat interval is 3s.
## If you change this value, you need to change the heartbeat interval of the flownode/frontend/datanode accordingly.
#+ heartbeat_interval = "3s"
## Whether to enable greptimedb telemetry. Enabled by default. ## Whether to enable greptimedb telemetry. Enabled by default.
#+ enable_telemetry = true #+ enable_telemetry = true
@@ -120,16 +109,6 @@ key_path = ""
## Like "/path/to/ca.crt" ## Like "/path/to/ca.crt"
ca_cert_path = "" ca_cert_path = ""
## The backend client options.
## Currently, only applicable when using etcd as the metadata store.
#+ [backend_client]
## The keep alive timeout for backend client.
#+ keep_alive_timeout = "3s"
## The keep alive interval for backend client.
#+ keep_alive_interval = "10s"
## The connect timeout for backend client.
#+ connect_timeout = "3s"
## The gRPC server options. ## The gRPC server options.
[grpc] [grpc]
## The address to bind the gRPC server. ## The address to bind the gRPC server.
@@ -144,10 +123,6 @@ runtime_size = 8
max_recv_message_size = "512MB" max_recv_message_size = "512MB"
## The maximum send message size for gRPC server. ## The maximum send message size for gRPC server.
max_send_message_size = "512MB" max_send_message_size = "512MB"
## The server side HTTP/2 keep-alive interval
#+ http2_keep_alive_interval = "10s"
## The server side HTTP/2 keep-alive timeout.
#+ http2_keep_alive_timeout = "3s"
## The HTTP server options. ## The HTTP server options.
[http] [http]

View File

@@ -6,16 +6,6 @@ default_timezone = "UTC"
## @toml2docs:none-default ## @toml2docs:none-default
default_column_prefix = "greptime" default_column_prefix = "greptime"
## Maximum total memory for all concurrent write request bodies and messages (HTTP, gRPC, Flight).
## Set to 0 to disable the limit. Default: "0" (unlimited)
## @toml2docs:none-default
#+ max_in_flight_write_bytes = "1GB"
## Policy when write bytes quota is exhausted.
## Options: "wait" (default, 10s timeout), "wait(<duration>)" (e.g., "wait(30s)"), "fail"
## @toml2docs:none-default
#+ write_bytes_exhausted_policy = "wait"
## Initialize all regions in the background during the startup. ## Initialize all regions in the background during the startup.
## By default, it provides services after all regions have been initialized. ## By default, it provides services after all regions have been initialized.
init_regions_in_background = false init_regions_in_background = false
@@ -32,6 +22,10 @@ max_concurrent_queries = 0
## Enable telemetry to collect anonymous usage data. Enabled by default. ## Enable telemetry to collect anonymous usage data. Enabled by default.
#+ enable_telemetry = true #+ enable_telemetry = true
## The maximum in-flight write bytes.
## @toml2docs:none-default
#+ max_in_flight_write_bytes = "500MB"
## The runtime options. ## The runtime options.
#+ [runtime] #+ [runtime]
## The number of threads to execute the runtime for global read operations. ## The number of threads to execute the runtime for global read operations.
@@ -49,6 +43,10 @@ timeout = "0s"
## The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`. ## The following units are supported: `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`.
## Set to 0 to disable limit. ## Set to 0 to disable limit.
body_limit = "64MB" body_limit = "64MB"
## Maximum total memory for all concurrent HTTP request bodies.
## Set to 0 to disable the limit. Default: "0" (unlimited)
## @toml2docs:none-default
#+ max_total_body_memory = "1GB"
## HTTP CORS support, it's turned on by default ## HTTP CORS support, it's turned on by default
## This allows browser to access http APIs without CORS restrictions ## This allows browser to access http APIs without CORS restrictions
enable_cors = true enable_cors = true
@@ -69,6 +67,10 @@ prom_validation_mode = "strict"
bind_addr = "127.0.0.1:4001" bind_addr = "127.0.0.1:4001"
## The number of server worker threads. ## The number of server worker threads.
runtime_size = 8 runtime_size = 8
## Maximum total memory for all concurrent gRPC request messages.
## Set to 0 to disable the limit. Default: "0" (unlimited)
## @toml2docs:none-default
#+ max_total_message_memory = "1GB"
## The maximum connection age for gRPC connection. ## The maximum connection age for gRPC connection.
## The value can be a human-readable time string. For example: `10m` for ten minutes or `1h` for one hour. ## The value can be a human-readable time string. For example: `10m` for ten minutes or `1h` for one hour.
## Refer to https://grpc.io/docs/guides/keepalive/ for more details. ## Refer to https://grpc.io/docs/guides/keepalive/ for more details.
@@ -228,14 +230,6 @@ recovery_parallelism = 2
## **It's only used when the provider is `kafka`**. ## **It's only used when the provider is `kafka`**.
broker_endpoints = ["127.0.0.1:9092"] broker_endpoints = ["127.0.0.1:9092"]
## The connect timeout for kafka client.
## **It's only used when the provider is `kafka`**.
#+ connect_timeout = "3s"
## The timeout for kafka client.
## **It's only used when the provider is `kafka`**.
#+ timeout = "3s"
## Automatically create topics for WAL. ## Automatically create topics for WAL.
## Set to `true` to automatically create topics for WAL. ## Set to `true` to automatically create topics for WAL.
## Otherwise, use topics named `topic_name_prefix_[0..num_topics)` ## Otherwise, use topics named `topic_name_prefix_[0..num_topics)`
@@ -338,7 +332,6 @@ max_running_procedures = 128
# endpoint = "https://s3.amazonaws.com" # endpoint = "https://s3.amazonaws.com"
# region = "us-west-2" # region = "us-west-2"
# enable_virtual_host_style = false # enable_virtual_host_style = false
# disable_ec2_metadata = false
# Example of using Oss as the storage. # Example of using Oss as the storage.
# [storage] # [storage]

View File

@@ -15,6 +15,7 @@
*/ */
import * as core from "@actions/core"; import * as core from "@actions/core";
import semver from "semver";
import {obtainClient} from "@/common"; import {obtainClient} from "@/common";
interface RepoConfig { interface RepoConfig {
@@ -57,32 +58,28 @@ const REPO_CONFIGS: Record<string, RepoConfig> = {
return ['bump-nightly-version.yml', version]; return ['bump-nightly-version.yml', version];
} }
// Check for prerelease versions (e.g., 1.0.0-beta.3, 1.0.0-rc.1) // Parse the version using semver library
const prereleaseMatch = version.match(/^(\d+)\.(\d+)\.(\d+)-(beta|rc)\.(\d+)$/); const parsedVersion = semver.parse(version);
if (prereleaseMatch) { if (!parsedVersion) {
const [, major, minor, patch, prereleaseType, prereleaseNum] = prereleaseMatch; throw new Error(`Invalid semantic version format: ${version}`);
// If it's beta.1 and patch version is 0, treat as major version
if (prereleaseType === 'beta' && prereleaseNum === '1' && patch === '0') {
return ['bump-version.yml', `${major}.${minor}`];
}
// Otherwise (beta.x where x > 1, or rc.x), treat as patch version
return ['bump-patch-version.yml', version];
} }
const parts = version.split('.'); // If there is a pre-release identifier, throw an error for manual determination
if (parts.length !== 3) { if (parsedVersion.prerelease && parsedVersion.prerelease.length > 0) {
throw new Error('Invalid version format'); throw new Error(
`Pre-release version "${version}" requires manual determination of which workflow to use.\n` +
`Please choose based on the specific situation:\n` +
` - bump-version.yml (for major.minor format, such as ${parsedVersion.major}.${parsedVersion.minor})\n` +
` - bump-patch-version.yml (for patch version, such as ${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch})\n` +
`Considerations include: Is this the first pre-release version? Is it close to the official release?`
);
} }
// If patch version (last number) is 0, it's a major version // Original logic for official versions
// Return only major.minor version if (parsedVersion.patch === 0) {
if (parts[2] === '0') { return ['bump-version.yml', `${parsedVersion.major}.${parsedVersion.minor}`];
return ['bump-version.yml', `${parts[0]}.${parts[1]}`];
} }
// Otherwise it's a patch version, use full version
return ['bump-patch-version.yml', version]; return ['bump-patch-version.yml', version];
} }
} }

View File

@@ -13,7 +13,8 @@
"conventional-commits-parser": "^5.0.0", "conventional-commits-parser": "^5.0.0",
"dayjs": "^1.11.11", "dayjs": "^1.11.11",
"dotenv": "^16.4.5", "dotenv": "^16.4.5",
"lodash": "^4.17.21" "lodash": "^4.17.21",
"semver": "^7.7.3"
}, },
"devDependencies": { "devDependencies": {
"@types/conventional-commits-parser": "^5.0.0", "@types/conventional-commits-parser": "^5.0.0",

872
cyborg/pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,94 +0,0 @@
---
Feature Name: Vector Index
Tracking Issue: TBD
Date: 2025-12-04
Author: "TBD"
---
# Summary
Introduce a per-SST approximate nearest neighbor (ANN) index for `VECTOR(dim)` columns with a pluggable engine. USearch HNSW is the initial engine, while the design keeps VSAG (default when linked) and future engines selectable at DDL or alter time and encoded in the index metadata. The index is built alongside SST creation and accelerates `ORDER BY vec_*_distance(column, <literal vector>) LIMIT k` queries, falling back to the existing brute-force path when an index is unavailable or ineligible.
# Motivation
Vector distances are currently computed with nalgebra across all rows (O(N)) before sorting, which does not scale to millions of vectors. An on-disk ANN index with sub-linear search reduces latency and compute cost for common RAG, semantic search, and recommendation workloads without changing SQL.
# Details
## Current Behavior
`VECTOR(dim)` values are stored as binary blobs. Queries call `vec_cos_distance`/`vec_l2sq_distance`/`vec_dot_product` via nalgebra for every row and then sort; there is no indexing or caching.
## Index Eligibility and Configuration
Only `VECTOR(dim)` columns can be indexed. A column metadata flag follows the existing column-option pattern with an intentionally small surface area:
- `engine`: `vsag` (default when the binding is built) or `usearch`. If a configured engine is unavailable at runtime, the builder logs and falls back to `usearch` while leaving the option intact for future rebuilds.
- `metric`: `cosine` (default), `l2sq`, or `dot`; mismatches with query functions force brute-force execution.
- `m`: HNSW graph connectivity (higher = denser graph, more memory, better recall), default `16`.
- `ef_construct`: build-time expansion, default `128`.
- `ef_search`: query-time expansion, default `64`; engines may clamp values.
Option semantics mirror HNSW defaults so both USearch and VSAG can honor them; engine-specific tunables stay in reserved key-value pairs inside the blob header for forward compatibility.
DDL reuses column extensions similar to inverted/fulltext indexes:
```sql
CREATE TABLE embeddings (
ts TIMESTAMP TIME INDEX,
id STRING PRIMARY KEY,
vec VECTOR(384) VECTOR INDEX WITH (engine = 'vsag', metric = 'cosine', ef_search = 64)
);
```
Altering column options toggles the flag, can switch engines (for example `usearch` -> `vsag`), and triggers rebuilds through the existing alter/compaction flow. Engine choice stays in table metadata and each blob header; new SSTs use the configured engine while older SSTs remain readable under their recorded engine until compaction or a manual rebuild rewrites them.
## Storage and Format
- One vector index per indexed column per SST, stored as a Puffin blob with type `greptime-vector-index-v1`.
- Each blob records the engine (`usearch`, `vsag`, future values) and engine parameters in the header so readers can select the matching decoder. Mixed-engine SSTs remain readable because the engine id travels with the blob.
- USearch uses `f32` vectors and SST row offsets (`u64`) as keys; nulls and `OpType::Delete` rows are skipped. Row ids are the absolute SST ordinal so readers can derive `RowSelection` directly from parquet row group lengths without extra side tables.
- Blob layout:
- Header: version, column id, dimension, engine id, metric, `m`, `ef_construct`, `ef_search`, and reserved engine-specific key-value pairs.
- Counts: total rows written and indexed rows.
- Payload: USearch binary produced by `save_to_buffer`.
- An empty index (no eligible vectors) results in no available index entry for that column.
- `puffin_manager` registers the blob type so caches and readers discover it alongside inverted/fulltext/bloom blobs in the same index file.
## Row Visibility and Duplicates
- The indexer increments `row_offset` for every incoming row (including skipped/null/delete rows) so offsets stay aligned with parquet ordering across row groups.
- Only `OpType::Put` rows with the expected dimension are inserted; `OpType::Delete` and malformed rows are skipped but still advance `row_offset`, matching the data planes visibility rules.
- Multiple versions of the same primary key remain in the graph; the read path intersects search hits with the standard mito2 deduplication/visibility pipeline (sequence-aware dedup, delete filtering, projection) before returning results.
- Searches overfetch beyond `k` to compensate for rows discarded by visibility checks and to avoid reissuing index reads.
## Build Path (mito2 write)
Extend `sst::index::Indexer` to optionally create a `VectorIndexer` when region metadata marks a column as vector-indexed, mirroring how inverted/fulltext/bloom filters attach to `IndexerBuilderImpl` in `mito2`.
The indexer consumes `Batch`/`RecordBatch` data and shares memory tracking and abort semantics with existing indexers:
- Maintain a running `row_offset` that follows SST write order and spans row groups so the search result can be turned into `RowSelection`.
- For each `OpType::Put`, if the vector is non-null and matches the declared dimension, insert into USearch with `row_offset` as the key; otherwise skip.
- Track memory with existing index build metrics; on failure, abort only the vector index while keeping SST writing unaffected.
Engine selection is table-driven: the builder picks the configured engine (default `vsag`, fallback `usearch` if `vsag` is not compiled in) and dispatches to the matching implementation. Unknown engines skip index build with a warning.
On `finish`, serialize the engine-tagged index into the Puffin writer and record `IndexType::Vector` metadata for the column. `IndexOutput` and `FileMeta::indexes/available_indexes` gain a vector entry so manifest updates and `RegionVersion` surface per-column presence, following patterns used by inverted/fulltext/bloom indexes. Planner/metadata validation ensures that mismatched dimensions only reduce the indexed-row count and do not break reads.
## Read Path (mito2 query)
A planner rule in `query` identifies eligible plans on mito2 tables: a single `ORDER BY vec_cos_distance|vec_l2sq_distance|vec_dot_product(<vector column>, <literal vector>)` in ascending order plus a `LIMIT`/`TopK`. The rule rejects plans with multiple sort keys, non-literal query vectors, or additional projections that would change the distance expression and falls back to brute-force in those cases.
For eligible scans, build a `VectorIndexScan` execution node that:
- Consults SST metadata for `IndexType::Vector`, loads the index via Puffin using the existing `mito2::cache::index` infrastructure, and dispatches to the engine declared in the blob header (USearch/VSAG/etc.).
- Runs the engines `search` with an overfetch (for example 2×k) to tolerate rows filtered by deletes, dimension mismatches, or late-stage dedup; keys already match SST row offsets produced by the writer.
- Converts hits to `RowSelection` using parquet row group lengths and reuses the parquet reader so visibility, projection, and deduplication logic stay unchanged; distances are recomputed with `vec_*_distance` before the final trim to k to guarantee ordering and to merge distributed partial results deterministically.
Any unsupported shape, load error, or cache miss falls back to the current brute-force execution path.
## Lifecycle and Maintenance
Lifecycle piggybacks on the existing SST/index flow: rebuilds run where other secondary indexes do, graphs are always rebuilt from source rows (no HNSW merge), and cleanup/versioning/caching reuse the existing Puffin and index cache paths.
# Implementation Plan
1. Add the `usearch` dependency (wrapper module in `index` or `mito2`) and map minimal HNSW options; keep an engine trait that allows plugging VSAG without changing the rest of the pipeline.
2. Introduce `IndexType::Vector` and a column metadata key for vector index options (including `engine`); add SQL parser and `SHOW CREATE TABLE` support for `VECTOR INDEX WITH (...)`.
3. Implement `vector_index` build/read modules under `mito2` (and `index` if shared), including Puffin serialization that records engine id, blob-type registration with `puffin_manager`, and integration with the `Indexer` builder, `IndexOutput`, manifest updates, and compaction rebuild.
4. Extend the query planner/execution to detect eligible plans and drive a `RowSelection`-based ANN scan with a fallback path, dispatching by engine at read time and using existing Puffin and index caches.
5. Add unit tests for serialization/search correctness and an end-to-end test covering plan rewrite, cache usage, engine selection, and fallback; add a mixed-engine test to confirm old USearch blobs still serve after a VSAG switch.
6. Follow up with an optional VSAG engine binding (feature flag), validate parity with USearch on dense vectors, exercise alternative algorithms (for example PQ), and flip the default `engine` to `vsag` when the binding is present.
# Alternatives
- **VSAG (follow-up engine):** C++ library with HNSW and additional algorithms (for example SINDI for sparse vectors and PQ) targeting in-memory and disk-friendly search. Provides parameter generators and a roadmap for GPU-assisted build and graph compression. Compared to FAISS it is newer with fewer integrations but bundles sparse/dense coverage and out-of-core focus in one engine. Fits the pluggable-engine design and would become the default `engine = 'vsag'` when linked; USearch remains available for lighter dependencies.
- **FAISS:** Broad feature set (IVF/IVFPQ/PQ/HNSW, GPU acceleration, scalar filtering, pre/post filters) and battle-tested performance across datasets, but it requires a heavier C++/GPU toolchain, has no official Rust binding, and is less disk-centric than VSAG; integrating it would add more build/distribution burden than USearch/VSAG.
- **Do nothing:** Keep brute-force evaluation, which remains O(N) and unacceptable at scale.

View File

@@ -895,7 +895,7 @@ pub fn is_column_type_value_eq(
.unwrap_or(false) .unwrap_or(false)
} }
pub fn encode_json_value(value: JsonValue) -> v1::JsonValue { fn encode_json_value(value: JsonValue) -> v1::JsonValue {
fn helper(json: JsonVariant) -> v1::JsonValue { fn helper(json: JsonVariant) -> v1::JsonValue {
let value = match json { let value = match json {
JsonVariant::Null => None, JsonVariant::Null => None,

View File

@@ -17,8 +17,8 @@ use std::collections::HashMap;
use arrow_schema::extension::{EXTENSION_TYPE_METADATA_KEY, EXTENSION_TYPE_NAME_KEY}; use arrow_schema::extension::{EXTENSION_TYPE_METADATA_KEY, EXTENSION_TYPE_NAME_KEY};
use datatypes::schema::{ use datatypes::schema::{
COMMENT_KEY, ColumnDefaultConstraint, ColumnSchema, FULLTEXT_KEY, FulltextAnalyzer, COMMENT_KEY, ColumnDefaultConstraint, ColumnSchema, FULLTEXT_KEY, FulltextAnalyzer,
FulltextBackend, FulltextOptions, INVERTED_INDEX_KEY, Metadata, SKIPPING_INDEX_KEY, FulltextBackend, FulltextOptions, INVERTED_INDEX_KEY, SKIPPING_INDEX_KEY, SkippingIndexOptions,
SkippingIndexOptions, SkippingIndexType, SkippingIndexType,
}; };
use greptime_proto::v1::{ use greptime_proto::v1::{
Analyzer, FulltextBackend as PbFulltextBackend, SkippingIndexType as PbSkippingIndexType, Analyzer, FulltextBackend as PbFulltextBackend, SkippingIndexType as PbSkippingIndexType,
@@ -36,14 +36,6 @@ const INVERTED_INDEX_GRPC_KEY: &str = "inverted_index";
/// Key used to store skip index options in gRPC column options. /// Key used to store skip index options in gRPC column options.
const SKIPPING_INDEX_GRPC_KEY: &str = "skipping_index"; const SKIPPING_INDEX_GRPC_KEY: &str = "skipping_index";
const COLUMN_OPTION_MAPPINGS: [(&str, &str); 5] = [
(FULLTEXT_GRPC_KEY, FULLTEXT_KEY),
(INVERTED_INDEX_GRPC_KEY, INVERTED_INDEX_KEY),
(SKIPPING_INDEX_GRPC_KEY, SKIPPING_INDEX_KEY),
(EXTENSION_TYPE_NAME_KEY, EXTENSION_TYPE_NAME_KEY),
(EXTENSION_TYPE_METADATA_KEY, EXTENSION_TYPE_METADATA_KEY),
];
/// Tries to construct a `ColumnSchema` from the given `ColumnDef`. /// Tries to construct a `ColumnSchema` from the given `ColumnDef`.
pub fn try_as_column_schema(column_def: &ColumnDef) -> Result<ColumnSchema> { pub fn try_as_column_schema(column_def: &ColumnDef) -> Result<ColumnSchema> {
let data_type = ColumnDataTypeWrapper::try_new( let data_type = ColumnDataTypeWrapper::try_new(
@@ -139,21 +131,6 @@ pub fn try_as_column_def(column_schema: &ColumnSchema, is_primary_key: bool) ->
}) })
} }
/// Collect the [ColumnOptions] into the [Metadata] that can be used in, for example, [ColumnSchema].
pub fn collect_column_options(column_options: Option<&ColumnOptions>) -> Metadata {
let Some(ColumnOptions { options }) = column_options else {
return Metadata::default();
};
let mut metadata = Metadata::with_capacity(options.len());
for (x, y) in COLUMN_OPTION_MAPPINGS {
if let Some(v) = options.get(x) {
metadata.insert(y.to_string(), v.clone());
}
}
metadata
}
/// Constructs a `ColumnOptions` from the given `ColumnSchema`. /// Constructs a `ColumnOptions` from the given `ColumnSchema`.
pub fn options_from_column_schema(column_schema: &ColumnSchema) -> Option<ColumnOptions> { pub fn options_from_column_schema(column_schema: &ColumnSchema) -> Option<ColumnOptions> {
let mut options = ColumnOptions::default(); let mut options = ColumnOptions::default();

View File

@@ -32,7 +32,6 @@ use crate::error::Result;
pub mod error; pub mod error;
pub mod information_extension; pub mod information_extension;
pub mod kvbackend; pub mod kvbackend;
#[cfg(any(test, feature = "testing"))]
pub mod memory; pub mod memory;
mod metrics; mod metrics;
pub mod system_schema; pub mod system_schema;

View File

@@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
pub(crate) const METRIC_DB_LABEL: &str = "db";
use lazy_static::lazy_static; use lazy_static::lazy_static;
use prometheus::*; use prometheus::*;
@@ -23,7 +25,7 @@ lazy_static! {
pub static ref METRIC_CATALOG_MANAGER_TABLE_COUNT: IntGaugeVec = register_int_gauge_vec!( pub static ref METRIC_CATALOG_MANAGER_TABLE_COUNT: IntGaugeVec = register_int_gauge_vec!(
"greptime_catalog_table_count", "greptime_catalog_table_count",
"catalog table count", "catalog table count",
&["db"] &[METRIC_DB_LABEL]
) )
.unwrap(); .unwrap();
pub static ref METRIC_CATALOG_KV_REMOTE_GET: Histogram = pub static ref METRIC_CATALOG_KV_REMOTE_GET: Histogram =

View File

@@ -24,7 +24,6 @@ use std::sync::Arc;
use common_error::ext::BoxedError; use common_error::ext::BoxedError;
use common_recordbatch::{RecordBatchStreamWrapper, SendableRecordBatchStream}; use common_recordbatch::{RecordBatchStreamWrapper, SendableRecordBatchStream};
use common_telemetry::tracing::Span;
use datatypes::schema::SchemaRef; use datatypes::schema::SchemaRef;
use futures_util::StreamExt; use futures_util::StreamExt;
use snafu::ResultExt; use snafu::ResultExt;
@@ -164,7 +163,6 @@ impl DataSource for SystemTableDataSource {
stream: Box::pin(stream), stream: Box::pin(stream),
output_ordering: None, output_ordering: None,
metrics: Default::default(), metrics: Default::default(),
span: Span::current(),
}; };
Ok(Box::pin(stream)) Ok(Box::pin(stream))

View File

@@ -399,8 +399,8 @@ impl InformationSchemaColumnsBuilder {
self.is_nullables.push(Some("No")); self.is_nullables.push(Some("No"));
} }
self.column_types.push(Some(&data_type)); self.column_types.push(Some(&data_type));
let column_comment = column_schema.column_comment().map(|x| x.as_ref()); self.column_comments
self.column_comments.push(column_comment); .push(column_schema.column_comment().map(|x| x.as_ref()));
} }
fn finish(&mut self) -> Result<RecordBatch> { fn finish(&mut self) -> Result<RecordBatch> {

View File

@@ -12,7 +12,6 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
use core::pin::pin;
use std::sync::{Arc, Weak}; use std::sync::{Arc, Weak};
use arrow_schema::SchemaRef as ArrowSchemaRef; use arrow_schema::SchemaRef as ArrowSchemaRef;
@@ -32,17 +31,15 @@ use datatypes::value::Value;
use datatypes::vectors::{ use datatypes::vectors::{
StringVectorBuilder, TimestampSecondVectorBuilder, UInt32VectorBuilder, UInt64VectorBuilder, StringVectorBuilder, TimestampSecondVectorBuilder, UInt32VectorBuilder, UInt64VectorBuilder,
}; };
use futures::StreamExt; use futures::TryStreamExt;
use snafu::{OptionExt, ResultExt}; use snafu::{OptionExt, ResultExt};
use store_api::storage::{ScanRequest, TableId}; use store_api::storage::{RegionId, ScanRequest, TableId};
use table::metadata::{TableInfo, TableType}; use table::metadata::{TableInfo, TableType};
use crate::CatalogManager; use crate::CatalogManager;
use crate::error::{ use crate::error::{
CreateRecordBatchSnafu, FindRegionRoutesSnafu, InternalSnafu, Result, CreateRecordBatchSnafu, InternalSnafu, Result, UpgradeWeakCatalogManagerRefSnafu,
UpgradeWeakCatalogManagerRefSnafu,
}; };
use crate::kvbackend::KvBackendCatalogManager;
use crate::system_schema::information_schema::{InformationTable, Predicates, TABLES}; use crate::system_schema::information_schema::{InformationTable, Predicates, TABLES};
use crate::system_schema::utils; use crate::system_schema::utils;
@@ -250,10 +247,6 @@ impl InformationSchemaTablesBuilder {
.catalog_manager .catalog_manager
.upgrade() .upgrade()
.context(UpgradeWeakCatalogManagerRefSnafu)?; .context(UpgradeWeakCatalogManagerRefSnafu)?;
let partition_manager = catalog_manager
.as_any()
.downcast_ref::<KvBackendCatalogManager>()
.map(|catalog_manager| catalog_manager.partition_manager());
let predicates = Predicates::from_scan_request(&request); let predicates = Predicates::from_scan_request(&request);
let information_extension = utils::information_extension(&self.catalog_manager)?; let information_extension = utils::information_extension(&self.catalog_manager)?;
@@ -274,59 +267,37 @@ impl InformationSchemaTablesBuilder {
}; };
for schema_name in catalog_manager.schema_names(&catalog_name, None).await? { for schema_name in catalog_manager.schema_names(&catalog_name, None).await? {
let table_stream = catalog_manager.tables(&catalog_name, &schema_name, None); let mut stream = catalog_manager.tables(&catalog_name, &schema_name, None);
const BATCH_SIZE: usize = 128; while let Some(table) = stream.try_next().await? {
// Split tables into chunks let table_info = table.table_info();
let mut table_chunks = pin!(table_stream.ready_chunks(BATCH_SIZE));
while let Some(tables) = table_chunks.next().await { // TODO(dennis): make it working for metric engine
let tables = tables.into_iter().collect::<Result<Vec<_>>>()?; let table_region_stats =
let mito_or_physical_table_ids = tables if table_info.meta.engine == MITO_ENGINE || table_info.is_physical_table() {
.iter() table_info
.filter(|table| { .meta
table.table_info().meta.engine == MITO_ENGINE .region_numbers
|| table.table_info().is_physical_table() .iter()
}) .map(|n| RegionId::new(table_info.ident.table_id, *n))
.map(|table| table.table_info().ident.table_id) .flat_map(|region_id| {
.collect::<Vec<_>>(); region_stats
.binary_search_by_key(&region_id, |x| x.id)
.map(|i| &region_stats[i])
})
.collect::<Vec<_>>()
} else {
vec![]
};
let table_routes = if let Some(partition_manager) = &partition_manager { self.add_table(
partition_manager &predicates,
.batch_find_region_routes(&mito_or_physical_table_ids) &catalog_name,
.await &schema_name,
.context(FindRegionRoutesSnafu)? table_info,
} else { table.table_type(),
mito_or_physical_table_ids &table_region_stats,
.into_iter() );
.map(|id| (id, vec![]))
.collect()
};
for table in tables {
let table_region_stats =
match table_routes.get(&table.table_info().ident.table_id) {
Some(routes) => routes
.iter()
.flat_map(|route| {
let region_id = route.region.id;
region_stats
.binary_search_by_key(&region_id, |x| x.id)
.map(|i| &region_stats[i])
})
.collect::<Vec<_>>(),
None => vec![],
};
self.add_table(
&predicates,
&catalog_name,
&schema_name,
table.table_info(),
table.table_type(),
&table_region_stats,
);
}
} }
} }

View File

@@ -337,7 +337,7 @@ mod tests {
.build(); .build();
let table_metadata_manager = TableMetadataManager::new(backend); let table_metadata_manager = TableMetadataManager::new(backend);
let mut view_info = common_meta::key::test_utils::new_test_table_info(1024); let mut view_info = common_meta::key::test_utils::new_test_table_info(1024, vec![]);
view_info.table_type = TableType::View; view_info.table_type = TableType::View;
let logical_plan = vec![1, 2, 3]; let logical_plan = vec![1, 2, 3];
// Create view metadata // Create view metadata

View File

@@ -67,7 +67,6 @@ tracing-appender.workspace = true
[dev-dependencies] [dev-dependencies]
common-meta = { workspace = true, features = ["testing"] } common-meta = { workspace = true, features = ["testing"] }
common-test-util.workspace = true
common-version.workspace = true common-version.workspace = true
serde.workspace = true serde.workspace = true
tempfile.workspace = true tempfile.workspace = true

View File

@@ -162,6 +162,7 @@ fn create_table_info(table_id: TableId, table_name: TableName) -> RawTableInfo {
next_column_id: columns as u32 + 1, next_column_id: columns as u32 + 1,
value_indices: vec![], value_indices: vec![],
options: Default::default(), options: Default::default(),
region_numbers: (1..=100).collect(),
partition_key_indices: vec![], partition_key_indices: vec![],
column_ids: vec![], column_ids: vec![],
}; };

View File

@@ -15,8 +15,5 @@
mod object_store; mod object_store;
mod store; mod store;
pub use object_store::{ pub use object_store::{ObjectStoreConfig, new_fs_object_store};
ObjectStoreConfig, PrefixedAzblobConnection, PrefixedGcsConnection, PrefixedOssConnection,
PrefixedS3Connection, new_fs_object_store,
};
pub use store::StoreConfig; pub use store::StoreConfig;

View File

@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
use common_base::secrets::{ExposeSecret, SecretString}; use common_base::secrets::SecretString;
use common_error::ext::BoxedError; use common_error::ext::BoxedError;
use object_store::services::{Azblob, Fs, Gcs, Oss, S3}; use object_store::services::{Azblob, Fs, Gcs, Oss, S3};
use object_store::util::{with_instrument_layers, with_retry_layers}; use object_store::util::{with_instrument_layers, with_retry_layers};
@@ -22,69 +22,9 @@ use snafu::ResultExt;
use crate::error::{self}; use crate::error::{self};
/// Trait to convert CLI field types to target struct field types.
/// This enables `Option<SecretString>` (CLI) -> `SecretString` (target) conversions,
/// allowing us to distinguish "not provided" from "provided but empty".
trait IntoField<T> {
fn into_field(self) -> T;
}
/// Identity conversion for types that are the same.
impl<T> IntoField<T> for T {
fn into_field(self) -> T {
self
}
}
/// Convert `Option<SecretString>` to `SecretString`, using default for None.
impl IntoField<SecretString> for Option<SecretString> {
fn into_field(self) -> SecretString {
self.unwrap_or_default()
}
}
/// Trait for checking if a field is effectively empty.
///
/// **`is_empty()`**: Checks if the field has no meaningful value
/// - Used when backend is enabled to validate required fields
/// - `None`, `Some("")`, `false`, or `""` are considered empty
trait FieldValidator {
/// Check if the field is empty (has no meaningful value).
fn is_empty(&self) -> bool;
}
/// String fields: empty if the string is empty
impl FieldValidator for String {
fn is_empty(&self) -> bool {
self.is_empty()
}
}
/// Bool fields: false is considered "empty", true is "provided"
impl FieldValidator for bool {
fn is_empty(&self) -> bool {
!self
}
}
/// Option<String> fields: None or empty content is empty
impl FieldValidator for Option<String> {
fn is_empty(&self) -> bool {
self.as_ref().is_none_or(|s| s.is_empty())
}
}
/// Option<SecretString> fields: None or empty secret is empty
/// For secrets, Some("") is treated as "not provided" for both checks
impl FieldValidator for Option<SecretString> {
fn is_empty(&self) -> bool {
self.as_ref().is_none_or(|s| s.expose_secret().is_empty())
}
}
macro_rules! wrap_with_clap_prefix { macro_rules! wrap_with_clap_prefix {
( (
$new_name:ident, $prefix:literal, $enable_flag:literal, $base:ty, { $new_name:ident, $prefix:literal, $base:ty, {
$( $( #[doc = $doc:expr] )? $( #[alias = $alias:literal] )? $field:ident : $type:ty $( = $default:expr )? ),* $(,)? $( $( #[doc = $doc:expr] )? $( #[alias = $alias:literal] )? $field:ident : $type:ty $( = $default:expr )? ),* $(,)?
} }
) => { ) => {
@@ -94,16 +34,15 @@ macro_rules! wrap_with_clap_prefix {
$( $(
$( #[doc = $doc] )? $( #[doc = $doc] )?
$( #[clap(alias = $alias)] )? $( #[clap(alias = $alias)] )?
#[clap(long, requires = $enable_flag $(, default_value_t = $default )? )] #[clap(long $(, default_value_t = $default )? )]
pub [<$prefix $field>]: $type, [<$prefix $field>]: $type,
)* )*
} }
impl From<$new_name> for $base { impl From<$new_name> for $base {
fn from(w: $new_name) -> Self { fn from(w: $new_name) -> Self {
Self { Self {
// Use into_field() to handle Option<SecretString> -> SecretString conversion $( $field: w.[<$prefix $field>] ),*
$( $field: w.[<$prefix $field>].into_field() ),*
} }
} }
} }
@@ -111,90 +50,9 @@ macro_rules! wrap_with_clap_prefix {
}; };
} }
/// Macro for declarative backend validation.
///
/// # Validation Rules
///
/// For each storage backend (S3, OSS, GCS, Azblob), this function validates:
/// **When backend is enabled** (e.g., `--s3`): All required fields must be non-empty
///
/// Note: When backend is disabled, clap's `requires` attribute ensures no configuration
/// fields can be provided at parse time.
///
/// # Syntax
///
/// ```ignore
/// validate_backend!(
/// enable: self.enable_s3,
/// name: "S3",
/// required: [(field1, "name1"), (field2, "name2"), ...],
/// custom_validator: |missing| { ... } // optional
/// )
/// ```
///
/// # Arguments
///
/// - `enable`: Boolean expression indicating if backend is enabled
/// - `name`: Human-readable backend name for error messages
/// - `required`: Array of (field_ref, field_name) tuples for required fields
/// - `custom_validator`: Optional closure for complex validation logic
///
/// # Example
///
/// ```ignore
/// validate_backend!(
/// enable: self.enable_s3,
/// name: "S3",
/// required: [
/// (&self.s3.s3_bucket, "bucket"),
/// (&self.s3.s3_access_key_id, "access key ID"),
/// ]
/// )
/// ```
macro_rules! validate_backend {
(
enable: $enable:expr,
name: $backend_name:expr,
required: [ $( ($field:expr, $field_name:expr) ),* $(,)? ]
$(, custom_validator: $custom_validator:expr)?
) => {{
if $enable {
// Check required fields when backend is enabled
let mut missing = Vec::new();
$(
if FieldValidator::is_empty($field) {
missing.push($field_name);
}
)*
// Run custom validation if provided
$(
$custom_validator(&mut missing);
)?
if !missing.is_empty() {
return Err(BoxedError::new(
error::MissingConfigSnafu {
msg: format!(
"{} {} must be set when --{} is enabled.",
$backend_name,
missing.join(", "),
$backend_name.to_lowercase()
),
}
.build(),
));
}
}
Ok(())
}};
}
wrap_with_clap_prefix! { wrap_with_clap_prefix! {
PrefixedAzblobConnection, PrefixedAzblobConnection,
"azblob-", "azblob-",
"enable_azblob",
AzblobConnection, AzblobConnection,
{ {
#[doc = "The container of the object store."] #[doc = "The container of the object store."]
@@ -202,9 +60,9 @@ wrap_with_clap_prefix! {
#[doc = "The root of the object store."] #[doc = "The root of the object store."]
root: String = Default::default(), root: String = Default::default(),
#[doc = "The account name of the object store."] #[doc = "The account name of the object store."]
account_name: Option<SecretString>, account_name: SecretString = Default::default(),
#[doc = "The account key of the object store."] #[doc = "The account key of the object store."]
account_key: Option<SecretString>, account_key: SecretString = Default::default(),
#[doc = "The endpoint of the object store."] #[doc = "The endpoint of the object store."]
endpoint: String = Default::default(), endpoint: String = Default::default(),
#[doc = "The SAS token of the object store."] #[doc = "The SAS token of the object store."]
@@ -212,33 +70,9 @@ wrap_with_clap_prefix! {
} }
} }
impl PrefixedAzblobConnection {
pub fn validate(&self) -> Result<(), BoxedError> {
validate_backend!(
enable: true,
name: "AzBlob",
required: [
(&self.azblob_container, "container"),
(&self.azblob_root, "root"),
(&self.azblob_account_name, "account name"),
(&self.azblob_endpoint, "endpoint"),
],
custom_validator: |missing: &mut Vec<&str>| {
// account_key is only required if sas_token is not provided
if self.azblob_sas_token.is_none()
&& self.azblob_account_key.is_empty()
{
missing.push("account key (when sas_token is not provided)");
}
}
)
}
}
wrap_with_clap_prefix! { wrap_with_clap_prefix! {
PrefixedS3Connection, PrefixedS3Connection,
"s3-", "s3-",
"enable_s3",
S3Connection, S3Connection,
{ {
#[doc = "The bucket of the object store."] #[doc = "The bucket of the object store."]
@@ -246,39 +80,21 @@ wrap_with_clap_prefix! {
#[doc = "The root of the object store."] #[doc = "The root of the object store."]
root: String = Default::default(), root: String = Default::default(),
#[doc = "The access key ID of the object store."] #[doc = "The access key ID of the object store."]
access_key_id: Option<SecretString>, access_key_id: SecretString = Default::default(),
#[doc = "The secret access key of the object store."] #[doc = "The secret access key of the object store."]
secret_access_key: Option<SecretString>, secret_access_key: SecretString = Default::default(),
#[doc = "The endpoint of the object store."] #[doc = "The endpoint of the object store."]
endpoint: Option<String>, endpoint: Option<String>,
#[doc = "The region of the object store."] #[doc = "The region of the object store."]
region: Option<String>, region: Option<String>,
#[doc = "Enable virtual host style for the object store."] #[doc = "Enable virtual host style for the object store."]
enable_virtual_host_style: bool = Default::default(), enable_virtual_host_style: bool = Default::default(),
#[doc = "Disable EC2 metadata service for the object store."]
disable_ec2_metadata: bool = Default::default(),
}
}
impl PrefixedS3Connection {
pub fn validate(&self) -> Result<(), BoxedError> {
validate_backend!(
enable: true,
name: "S3",
required: [
(&self.s3_bucket, "bucket"),
(&self.s3_access_key_id, "access key ID"),
(&self.s3_secret_access_key, "secret access key"),
(&self.s3_region, "region"),
]
)
} }
} }
wrap_with_clap_prefix! { wrap_with_clap_prefix! {
PrefixedOssConnection, PrefixedOssConnection,
"oss-", "oss-",
"enable_oss",
OssConnection, OssConnection,
{ {
#[doc = "The bucket of the object store."] #[doc = "The bucket of the object store."]
@@ -286,33 +102,17 @@ wrap_with_clap_prefix! {
#[doc = "The root of the object store."] #[doc = "The root of the object store."]
root: String = Default::default(), root: String = Default::default(),
#[doc = "The access key ID of the object store."] #[doc = "The access key ID of the object store."]
access_key_id: Option<SecretString>, access_key_id: SecretString = Default::default(),
#[doc = "The access key secret of the object store."] #[doc = "The access key secret of the object store."]
access_key_secret: Option<SecretString>, access_key_secret: SecretString = Default::default(),
#[doc = "The endpoint of the object store."] #[doc = "The endpoint of the object store."]
endpoint: String = Default::default(), endpoint: String = Default::default(),
} }
} }
impl PrefixedOssConnection {
pub fn validate(&self) -> Result<(), BoxedError> {
validate_backend!(
enable: true,
name: "OSS",
required: [
(&self.oss_bucket, "bucket"),
(&self.oss_access_key_id, "access key ID"),
(&self.oss_access_key_secret, "access key secret"),
(&self.oss_endpoint, "endpoint"),
]
)
}
}
wrap_with_clap_prefix! { wrap_with_clap_prefix! {
PrefixedGcsConnection, PrefixedGcsConnection,
"gcs-", "gcs-",
"enable_gcs",
GcsConnection, GcsConnection,
{ {
#[doc = "The root of the object store."] #[doc = "The root of the object store."]
@@ -322,72 +122,40 @@ wrap_with_clap_prefix! {
#[doc = "The scope of the object store."] #[doc = "The scope of the object store."]
scope: String = Default::default(), scope: String = Default::default(),
#[doc = "The credential path of the object store."] #[doc = "The credential path of the object store."]
credential_path: Option<SecretString>, credential_path: SecretString = Default::default(),
#[doc = "The credential of the object store."] #[doc = "The credential of the object store."]
credential: Option<SecretString>, credential: SecretString = Default::default(),
#[doc = "The endpoint of the object store."] #[doc = "The endpoint of the object store."]
endpoint: String = Default::default(), endpoint: String = Default::default(),
} }
} }
impl PrefixedGcsConnection { /// common config for object store.
pub fn validate(&self) -> Result<(), BoxedError> {
validate_backend!(
enable: true,
name: "GCS",
required: [
(&self.gcs_bucket, "bucket"),
(&self.gcs_root, "root"),
(&self.gcs_scope, "scope"),
]
// No custom_validator needed: GCS supports Application Default Credentials (ADC)
// where neither credential_path nor credential is required.
// Endpoint is also optional (defaults to https://storage.googleapis.com).
)
}
}
/// Common config for object store.
///
/// # Dependency Enforcement
///
/// Each backend's configuration fields (e.g., `--s3-bucket`) requires its corresponding
/// enable flag (e.g., `--s3`) to be present. This is enforced by `clap` at parse time
/// using the `requires` attribute.
///
/// For example, attempting to use `--s3-bucket my-bucket` without `--s3` will result in:
/// ```text
/// error: The argument '--s3-bucket <BUCKET>' requires '--s3'
/// ```
///
/// This ensures that users cannot accidentally provide backend-specific configuration
/// without explicitly enabling that backend.
#[derive(clap::Parser, Debug, Clone, PartialEq, Default)] #[derive(clap::Parser, Debug, Clone, PartialEq, Default)]
#[clap(group(clap::ArgGroup::new("storage_backend").required(false).multiple(false)))]
pub struct ObjectStoreConfig { pub struct ObjectStoreConfig {
/// Whether to use S3 object store. /// Whether to use S3 object store.
#[clap(long = "s3", group = "storage_backend")] #[clap(long, alias = "s3")]
pub enable_s3: bool, pub enable_s3: bool,
#[clap(flatten)] #[clap(flatten)]
pub s3: PrefixedS3Connection, pub s3: PrefixedS3Connection,
/// Whether to use OSS. /// Whether to use OSS.
#[clap(long = "oss", group = "storage_backend")] #[clap(long, alias = "oss")]
pub enable_oss: bool, pub enable_oss: bool,
#[clap(flatten)] #[clap(flatten)]
pub oss: PrefixedOssConnection, pub oss: PrefixedOssConnection,
/// Whether to use GCS. /// Whether to use GCS.
#[clap(long = "gcs", group = "storage_backend")] #[clap(long, alias = "gcs")]
pub enable_gcs: bool, pub enable_gcs: bool,
#[clap(flatten)] #[clap(flatten)]
pub gcs: PrefixedGcsConnection, pub gcs: PrefixedGcsConnection,
/// Whether to use Azure Blob. /// Whether to use Azure Blob.
#[clap(long = "azblob", group = "storage_backend")] #[clap(long, alias = "azblob")]
pub enable_azblob: bool, pub enable_azblob: bool,
#[clap(flatten)] #[clap(flatten)]
@@ -405,66 +173,52 @@ pub fn new_fs_object_store(root: &str) -> std::result::Result<ObjectStore, Boxed
Ok(with_instrument_layers(object_store, false)) Ok(with_instrument_layers(object_store, false))
} }
macro_rules! gen_object_store_builder {
($method:ident, $field:ident, $conn_type:ty, $service_type:ty) => {
pub fn $method(&self) -> Result<ObjectStore, BoxedError> {
let config = <$conn_type>::from(self.$field.clone());
common_telemetry::info!(
"Building object store with {}: {:?}",
stringify!($field),
config
);
let object_store = ObjectStore::new(<$service_type>::from(&config))
.context(error::InitBackendSnafu)
.map_err(BoxedError::new)?
.finish();
Ok(with_instrument_layers(
with_retry_layers(object_store),
false,
))
}
};
}
impl ObjectStoreConfig { impl ObjectStoreConfig {
gen_object_store_builder!(build_s3, s3, S3Connection, S3);
gen_object_store_builder!(build_oss, oss, OssConnection, Oss);
gen_object_store_builder!(build_gcs, gcs, GcsConnection, Gcs);
gen_object_store_builder!(build_azblob, azblob, AzblobConnection, Azblob);
pub fn validate(&self) -> Result<(), BoxedError> {
if self.enable_s3 {
self.s3.validate()?;
}
if self.enable_oss {
self.oss.validate()?;
}
if self.enable_gcs {
self.gcs.validate()?;
}
if self.enable_azblob {
self.azblob.validate()?;
}
Ok(())
}
/// Builds the object store from the config. /// Builds the object store from the config.
pub fn build(&self) -> Result<Option<ObjectStore>, BoxedError> { pub fn build(&self) -> Result<Option<ObjectStore>, BoxedError> {
self.validate()?; let object_store = if self.enable_s3 {
let s3 = S3Connection::from(self.s3.clone());
if self.enable_s3 { common_telemetry::info!("Building object store with s3: {:?}", s3);
self.build_s3().map(Some) Some(
ObjectStore::new(S3::from(&s3))
.context(error::InitBackendSnafu)
.map_err(BoxedError::new)?
.finish(),
)
} else if self.enable_oss { } else if self.enable_oss {
self.build_oss().map(Some) let oss = OssConnection::from(self.oss.clone());
common_telemetry::info!("Building object store with oss: {:?}", oss);
Some(
ObjectStore::new(Oss::from(&oss))
.context(error::InitBackendSnafu)
.map_err(BoxedError::new)?
.finish(),
)
} else if self.enable_gcs { } else if self.enable_gcs {
self.build_gcs().map(Some) let gcs = GcsConnection::from(self.gcs.clone());
common_telemetry::info!("Building object store with gcs: {:?}", gcs);
Some(
ObjectStore::new(Gcs::from(&gcs))
.context(error::InitBackendSnafu)
.map_err(BoxedError::new)?
.finish(),
)
} else if self.enable_azblob { } else if self.enable_azblob {
self.build_azblob().map(Some) let azblob = AzblobConnection::from(self.azblob.clone());
common_telemetry::info!("Building object store with azblob: {:?}", azblob);
Some(
ObjectStore::new(Azblob::from(&azblob))
.context(error::InitBackendSnafu)
.map_err(BoxedError::new)?
.finish(),
)
} else { } else {
Ok(None) None
} };
let object_store = object_store
.map(|object_store| with_instrument_layers(with_retry_layers(object_store), false));
Ok(object_store)
} }
} }

View File

@@ -19,7 +19,7 @@ use common_error::ext::BoxedError;
use common_meta::kv_backend::KvBackendRef; use common_meta::kv_backend::KvBackendRef;
use common_meta::kv_backend::chroot::ChrootKvBackend; use common_meta::kv_backend::chroot::ChrootKvBackend;
use common_meta::kv_backend::etcd::EtcdStore; use common_meta::kv_backend::etcd::EtcdStore;
use meta_srv::metasrv::{BackendClientOptions, BackendImpl}; use meta_srv::metasrv::BackendImpl;
use meta_srv::utils::etcd::create_etcd_client_with_tls; use meta_srv::utils::etcd::create_etcd_client_with_tls;
use servers::tls::{TlsMode, TlsOption}; use servers::tls::{TlsMode, TlsOption};
@@ -61,12 +61,6 @@ pub struct StoreConfig {
#[cfg(feature = "pg_kvbackend")] #[cfg(feature = "pg_kvbackend")]
#[clap(long)] #[clap(long)]
pub meta_schema_name: Option<String>, pub meta_schema_name: Option<String>,
/// Automatically create PostgreSQL schema if it doesn't exist (default: true).
#[cfg(feature = "pg_kvbackend")]
#[clap(long, default_value_t = true)]
pub auto_create_schema: bool,
/// TLS mode for backend store connections (etcd, PostgreSQL, MySQL) /// TLS mode for backend store connections (etcd, PostgreSQL, MySQL)
#[clap(long = "backend-tls-mode", value_enum, default_value = "disable")] #[clap(long = "backend-tls-mode", value_enum, default_value = "disable")]
pub backend_tls_mode: TlsMode, pub backend_tls_mode: TlsMode,
@@ -92,7 +86,7 @@ impl StoreConfig {
pub fn tls_config(&self) -> Option<TlsOption> { pub fn tls_config(&self) -> Option<TlsOption> {
if self.backend_tls_mode != TlsMode::Disable { if self.backend_tls_mode != TlsMode::Disable {
Some(TlsOption { Some(TlsOption {
mode: self.backend_tls_mode, mode: self.backend_tls_mode.clone(),
cert_path: self.backend_tls_cert_path.clone(), cert_path: self.backend_tls_cert_path.clone(),
key_path: self.backend_tls_key_path.clone(), key_path: self.backend_tls_key_path.clone(),
ca_cert_path: self.backend_tls_ca_cert_path.clone(), ca_cert_path: self.backend_tls_ca_cert_path.clone(),
@@ -118,13 +112,9 @@ impl StoreConfig {
let kvbackend = match self.backend { let kvbackend = match self.backend {
BackendImpl::EtcdStore => { BackendImpl::EtcdStore => {
let tls_config = self.tls_config(); let tls_config = self.tls_config();
let etcd_client = create_etcd_client_with_tls( let etcd_client = create_etcd_client_with_tls(store_addrs, tls_config.as_ref())
store_addrs, .await
&BackendClientOptions::default(), .map_err(BoxedError::new)?;
tls_config.as_ref(),
)
.await
.map_err(BoxedError::new)?;
Ok(EtcdStore::with_etcd_client(etcd_client, max_txn_ops)) Ok(EtcdStore::with_etcd_client(etcd_client, max_txn_ops))
} }
#[cfg(feature = "pg_kvbackend")] #[cfg(feature = "pg_kvbackend")]
@@ -144,7 +134,6 @@ impl StoreConfig {
schema_name, schema_name,
table_name, table_name,
max_txn_ops, max_txn_ops,
self.auto_create_schema,
) )
.await .await
.map_err(BoxedError::new)?) .map_err(BoxedError::new)?)

View File

@@ -14,7 +14,6 @@
mod export; mod export;
mod import; mod import;
mod storage_export;
use clap::Subcommand; use clap::Subcommand;
use client::DEFAULT_CATALOG_NAME; use client::DEFAULT_CATALOG_NAME;

File diff suppressed because it is too large Load Diff

View File

@@ -1,373 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
use std::path::PathBuf;
use common_base::secrets::{ExposeSecret, SecretString};
use common_error::ext::BoxedError;
use crate::common::{
PrefixedAzblobConnection, PrefixedGcsConnection, PrefixedOssConnection, PrefixedS3Connection,
};
/// Helper function to extract secret string from Option<SecretString>.
/// Returns empty string if None.
fn expose_optional_secret(secret: &Option<SecretString>) -> &str {
secret
.as_ref()
.map(|s| s.expose_secret().as_str())
.unwrap_or("")
}
/// Helper function to format root path with leading slash if non-empty.
fn format_root_path(root: &str) -> String {
if root.is_empty() {
String::new()
} else {
format!("/{}", root)
}
}
/// Helper function to mask multiple secrets in a string.
fn mask_secrets(mut sql: String, secrets: &[&str]) -> String {
for secret in secrets {
if !secret.is_empty() {
sql = sql.replace(secret, "[REDACTED]");
}
}
sql
}
/// Helper function to format storage URI.
fn format_uri(scheme: &str, bucket: &str, root: &str, path: &str) -> String {
let root = format_root_path(root);
format!("{}://{}{}/{}", scheme, bucket, root, path)
}
/// Trait for storage backends that can be used for data export.
pub trait StorageExport: Send + Sync {
/// Generate the storage path for COPY DATABASE command.
/// Returns (path, connection_string) where connection_string includes CONNECTION clause.
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String);
/// Format the output path for logging purposes.
fn format_output_path(&self, file_path: &str) -> String;
/// Mask sensitive information in SQL commands for safe logging.
fn mask_sensitive_info(&self, sql: &str) -> String;
}
macro_rules! define_backend {
($name:ident, $config:ty) => {
#[derive(Clone)]
pub struct $name {
config: $config,
}
impl $name {
pub fn new(config: $config) -> Result<Self, BoxedError> {
config.validate()?;
Ok(Self { config })
}
}
};
}
/// Local file system storage backend.
#[derive(Clone)]
pub struct FsBackend {
output_dir: String,
}
impl FsBackend {
pub fn new(output_dir: String) -> Self {
Self { output_dir }
}
}
impl StorageExport for FsBackend {
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String) {
if self.output_dir.is_empty() {
unreachable!("output_dir must be set when not using remote storage")
}
let path = PathBuf::from(&self.output_dir)
.join(catalog)
.join(format!("{schema}/"))
.to_string_lossy()
.to_string();
(path, String::new())
}
fn format_output_path(&self, file_path: &str) -> String {
format!("{}/{}", self.output_dir, file_path)
}
fn mask_sensitive_info(&self, sql: &str) -> String {
sql.to_string()
}
}
define_backend!(S3Backend, PrefixedS3Connection);
impl StorageExport for S3Backend {
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String) {
let s3_path = format_uri(
"s3",
&self.config.s3_bucket,
&self.config.s3_root,
&format!("{}/{}/", catalog, schema),
);
let mut connection_options = vec![
format!(
"ACCESS_KEY_ID='{}'",
expose_optional_secret(&self.config.s3_access_key_id)
),
format!(
"SECRET_ACCESS_KEY='{}'",
expose_optional_secret(&self.config.s3_secret_access_key)
),
];
if let Some(region) = &self.config.s3_region {
connection_options.push(format!("REGION='{}'", region));
}
if let Some(endpoint) = &self.config.s3_endpoint {
connection_options.push(format!("ENDPOINT='{}'", endpoint));
}
let connection_str = format!(" CONNECTION ({})", connection_options.join(", "));
(s3_path, connection_str)
}
fn format_output_path(&self, file_path: &str) -> String {
format_uri(
"s3",
&self.config.s3_bucket,
&self.config.s3_root,
file_path,
)
}
fn mask_sensitive_info(&self, sql: &str) -> String {
mask_secrets(
sql.to_string(),
&[
expose_optional_secret(&self.config.s3_access_key_id),
expose_optional_secret(&self.config.s3_secret_access_key),
],
)
}
}
define_backend!(OssBackend, PrefixedOssConnection);
impl StorageExport for OssBackend {
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String) {
let oss_path = format_uri(
"oss",
&self.config.oss_bucket,
&self.config.oss_root,
&format!("{}/{}/", catalog, schema),
);
let connection_options = [
format!(
"ACCESS_KEY_ID='{}'",
expose_optional_secret(&self.config.oss_access_key_id)
),
format!(
"ACCESS_KEY_SECRET='{}'",
expose_optional_secret(&self.config.oss_access_key_secret)
),
];
let connection_str = format!(" CONNECTION ({})", connection_options.join(", "));
(oss_path, connection_str)
}
fn format_output_path(&self, file_path: &str) -> String {
format_uri(
"oss",
&self.config.oss_bucket,
&self.config.oss_root,
file_path,
)
}
fn mask_sensitive_info(&self, sql: &str) -> String {
mask_secrets(
sql.to_string(),
&[
expose_optional_secret(&self.config.oss_access_key_id),
expose_optional_secret(&self.config.oss_access_key_secret),
],
)
}
}
define_backend!(GcsBackend, PrefixedGcsConnection);
impl StorageExport for GcsBackend {
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String) {
let gcs_path = format_uri(
"gcs",
&self.config.gcs_bucket,
&self.config.gcs_root,
&format!("{}/{}/", catalog, schema),
);
let mut connection_options = Vec::new();
let credential_path = expose_optional_secret(&self.config.gcs_credential_path);
if !credential_path.is_empty() {
connection_options.push(format!("CREDENTIAL_PATH='{}'", credential_path));
}
let credential = expose_optional_secret(&self.config.gcs_credential);
if !credential.is_empty() {
connection_options.push(format!("CREDENTIAL='{}'", credential));
}
if !self.config.gcs_endpoint.is_empty() {
connection_options.push(format!("ENDPOINT='{}'", self.config.gcs_endpoint));
}
let connection_str = if connection_options.is_empty() {
String::new()
} else {
format!(" CONNECTION ({})", connection_options.join(", "))
};
(gcs_path, connection_str)
}
fn format_output_path(&self, file_path: &str) -> String {
format_uri(
"gcs",
&self.config.gcs_bucket,
&self.config.gcs_root,
file_path,
)
}
fn mask_sensitive_info(&self, sql: &str) -> String {
mask_secrets(
sql.to_string(),
&[
expose_optional_secret(&self.config.gcs_credential_path),
expose_optional_secret(&self.config.gcs_credential),
],
)
}
}
define_backend!(AzblobBackend, PrefixedAzblobConnection);
impl StorageExport for AzblobBackend {
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String) {
let azblob_path = format_uri(
"azblob",
&self.config.azblob_container,
&self.config.azblob_root,
&format!("{}/{}/", catalog, schema),
);
let mut connection_options = vec![
format!(
"ACCOUNT_NAME='{}'",
expose_optional_secret(&self.config.azblob_account_name)
),
format!(
"ACCOUNT_KEY='{}'",
expose_optional_secret(&self.config.azblob_account_key)
),
];
if let Some(sas_token) = &self.config.azblob_sas_token {
connection_options.push(format!("SAS_TOKEN='{}'", sas_token));
}
let connection_str = format!(" CONNECTION ({})", connection_options.join(", "));
(azblob_path, connection_str)
}
fn format_output_path(&self, file_path: &str) -> String {
format_uri(
"azblob",
&self.config.azblob_container,
&self.config.azblob_root,
file_path,
)
}
fn mask_sensitive_info(&self, sql: &str) -> String {
mask_secrets(
sql.to_string(),
&[
expose_optional_secret(&self.config.azblob_account_name),
expose_optional_secret(&self.config.azblob_account_key),
],
)
}
}
#[derive(Clone)]
pub enum StorageType {
Fs(FsBackend),
S3(S3Backend),
Oss(OssBackend),
Gcs(GcsBackend),
Azblob(AzblobBackend),
}
impl StorageExport for StorageType {
fn get_storage_path(&self, catalog: &str, schema: &str) -> (String, String) {
match self {
StorageType::Fs(backend) => backend.get_storage_path(catalog, schema),
StorageType::S3(backend) => backend.get_storage_path(catalog, schema),
StorageType::Oss(backend) => backend.get_storage_path(catalog, schema),
StorageType::Gcs(backend) => backend.get_storage_path(catalog, schema),
StorageType::Azblob(backend) => backend.get_storage_path(catalog, schema),
}
}
fn format_output_path(&self, file_path: &str) -> String {
match self {
StorageType::Fs(backend) => backend.format_output_path(file_path),
StorageType::S3(backend) => backend.format_output_path(file_path),
StorageType::Oss(backend) => backend.format_output_path(file_path),
StorageType::Gcs(backend) => backend.format_output_path(file_path),
StorageType::Azblob(backend) => backend.format_output_path(file_path),
}
}
fn mask_sensitive_info(&self, sql: &str) -> String {
match self {
StorageType::Fs(backend) => backend.mask_sensitive_info(sql),
StorageType::S3(backend) => backend.mask_sensitive_info(sql),
StorageType::Oss(backend) => backend.mask_sensitive_info(sql),
StorageType::Gcs(backend) => backend.mask_sensitive_info(sql),
StorageType::Azblob(backend) => backend.mask_sensitive_info(sql),
}
}
}
impl StorageType {
/// Returns true if the storage backend is remote (not local filesystem).
pub fn is_remote_storage(&self) -> bool {
!matches!(self, StorageType::Fs(_))
}
}

View File

@@ -253,6 +253,12 @@ pub enum Error {
error: ObjectStoreError, error: ObjectStoreError,
}, },
#[snafu(display("S3 config need be set"))]
S3ConfigNotSet {
#[snafu(implicit)]
location: Location,
},
#[snafu(display("Output directory not set"))] #[snafu(display("Output directory not set"))]
OutputDirNotSet { OutputDirNotSet {
#[snafu(implicit)] #[snafu(implicit)]
@@ -358,9 +364,9 @@ impl ErrorExt for Error {
Error::Other { source, .. } => source.status_code(), Error::Other { source, .. } => source.status_code(),
Error::OpenDal { .. } | Error::InitBackend { .. } => StatusCode::Internal, Error::OpenDal { .. } | Error::InitBackend { .. } => StatusCode::Internal,
Error::OutputDirNotSet { .. } | Error::EmptyStoreAddrs { .. } => { Error::S3ConfigNotSet { .. }
StatusCode::InvalidArguments | Error::OutputDirNotSet { .. }
} | Error::EmptyStoreAddrs { .. } => StatusCode::InvalidArguments,
Error::BuildRuntime { source, .. } => source.status_code(), Error::BuildRuntime { source, .. } => source.status_code(),

View File

@@ -37,7 +37,6 @@ use common_grpc::flight::{FlightDecoder, FlightMessage};
use common_query::Output; use common_query::Output;
use common_recordbatch::error::ExternalSnafu; use common_recordbatch::error::ExternalSnafu;
use common_recordbatch::{RecordBatch, RecordBatchStreamWrapper}; use common_recordbatch::{RecordBatch, RecordBatchStreamWrapper};
use common_telemetry::tracing::Span;
use common_telemetry::tracing_context::W3cTrace; use common_telemetry::tracing_context::W3cTrace;
use common_telemetry::{error, warn}; use common_telemetry::{error, warn};
use futures::future; use futures::future;
@@ -457,7 +456,6 @@ impl Database {
stream, stream,
output_ordering: None, output_ordering: None,
metrics: Default::default(), metrics: Default::default(),
span: Span::current(),
}; };
Ok(Output::new_with_stream(Box::pin(record_batch_stream))) Ok(Output::new_with_stream(Box::pin(record_batch_stream)))
} }

View File

@@ -30,7 +30,6 @@ use common_query::request::QueryRequest;
use common_recordbatch::error::ExternalSnafu; use common_recordbatch::error::ExternalSnafu;
use common_recordbatch::{RecordBatch, RecordBatchStreamWrapper, SendableRecordBatchStream}; use common_recordbatch::{RecordBatch, RecordBatchStreamWrapper, SendableRecordBatchStream};
use common_telemetry::error; use common_telemetry::error;
use common_telemetry::tracing::Span;
use common_telemetry::tracing_context::TracingContext; use common_telemetry::tracing_context::TracingContext;
use prost::Message; use prost::Message;
use query::query_engine::DefaultSerializer; use query::query_engine::DefaultSerializer;
@@ -243,7 +242,6 @@ impl RegionRequester {
stream, stream,
output_ordering: None, output_ordering: None,
metrics, metrics,
span: Span::current(),
}; };
Ok(Box::pin(record_batch_stream)) Ok(Box::pin(record_batch_stream))
} }

View File

@@ -18,7 +18,6 @@ default = [
] ]
enterprise = ["common-meta/enterprise", "frontend/enterprise", "meta-srv/enterprise"] enterprise = ["common-meta/enterprise", "frontend/enterprise", "meta-srv/enterprise"]
tokio-console = ["common-telemetry/tokio-console"] tokio-console = ["common-telemetry/tokio-console"]
vector_index = ["mito2/vector_index"]
[lints] [lints]
workspace = true workspace = true

View File

@@ -330,6 +330,7 @@ mod tests {
use common_config::ENV_VAR_SEP; use common_config::ENV_VAR_SEP;
use common_test_util::temp_dir::create_named_temp_file; use common_test_util::temp_dir::create_named_temp_file;
use object_store::config::{FileConfig, GcsConfig, ObjectStoreConfig, S3Config}; use object_store::config::{FileConfig, GcsConfig, ObjectStoreConfig, S3Config};
use servers::heartbeat_options::HeartbeatOptions;
use super::*; use super::*;
use crate::options::GlobalOptions; use crate::options::GlobalOptions;
@@ -373,6 +374,9 @@ mod tests {
hostname = "127.0.0.1" hostname = "127.0.0.1"
runtime_size = 8 runtime_size = 8
[heartbeat]
interval = "300ms"
[meta_client] [meta_client]
metasrv_addrs = ["127.0.0.1:3002"] metasrv_addrs = ["127.0.0.1:3002"]
timeout = "3s" timeout = "3s"
@@ -430,6 +434,13 @@ mod tests {
); );
assert!(!raft_engine_config.sync_write); assert!(!raft_engine_config.sync_write);
let HeartbeatOptions {
interval: heart_beat_interval,
..
} = options.heartbeat;
assert_eq!(300, heart_beat_interval.as_millis());
let MetaClientOptions { let MetaClientOptions {
metasrv_addrs: metasrv_addr, metasrv_addrs: metasrv_addr,
timeout, timeout,

View File

@@ -233,8 +233,6 @@ impl ObjbenchCommand {
inverted_index_config: MitoConfig::default().inverted_index, inverted_index_config: MitoConfig::default().inverted_index,
fulltext_index_config, fulltext_index_config,
bloom_filter_index_config: MitoConfig::default().bloom_filter_index, bloom_filter_index_config: MitoConfig::default().bloom_filter_index,
#[cfg(feature = "vector_index")]
vector_index_config: Default::default(),
}; };
// Write SST // Write SST

View File

@@ -358,6 +358,7 @@ impl StartCommand {
let heartbeat_task = flow::heartbeat::HeartbeatTask::new( let heartbeat_task = flow::heartbeat::HeartbeatTask::new(
&opts, &opts,
meta_client.clone(), meta_client.clone(),
opts.heartbeat.clone(),
Arc::new(executor), Arc::new(executor),
Arc::new(resource_stat), Arc::new(resource_stat),
); );

View File

@@ -236,7 +236,7 @@ impl StartCommand {
}; };
let tls_opts = TlsOption::new( let tls_opts = TlsOption::new(
self.tls_mode, self.tls_mode.clone(),
self.tls_cert_path.clone(), self.tls_cert_path.clone(),
self.tls_key_path.clone(), self.tls_key_path.clone(),
self.tls_watch, self.tls_watch,

View File

@@ -108,7 +108,7 @@ pub trait App: Send {
} }
} }
/// Log the versions of the application. /// Log the versions of the application, and the arguments passed to the cli.
/// ///
/// `version` should be the same as the output of cli "--version"; /// `version` should be the same as the output of cli "--version";
/// and the `short_version` is the short version of the codes, often consist of git branch and commit. /// and the `short_version` is the short version of the codes, often consist of git branch and commit.
@@ -118,7 +118,10 @@ pub fn log_versions(version: &str, short_version: &str, app: &str) {
.with_label_values(&[common_version::version(), short_version, app]) .with_label_values(&[common_version::version(), short_version, app])
.inc(); .inc();
// Log version and argument flags.
info!("GreptimeDB version: {}", version); info!("GreptimeDB version: {}", version);
log_env_flags();
} }
pub fn create_resource_limit_metrics(app: &str) { pub fn create_resource_limit_metrics(app: &str) {
@@ -141,6 +144,13 @@ pub fn create_resource_limit_metrics(app: &str) {
} }
} }
fn log_env_flags() {
info!("command line arguments");
for argument in std::env::args() {
info!("argument: {}", argument);
}
}
pub fn maybe_activate_heap_profile(memory_options: &common_options::memory::MemoryOptions) { pub fn maybe_activate_heap_profile(memory_options: &common_options::memory::MemoryOptions) {
if memory_options.enable_heap_profiling { if memory_options.enable_heap_profiling {
match activate_heap_profile() { match activate_heap_profile() {

View File

@@ -20,7 +20,6 @@ use async_trait::async_trait;
use clap::Parser; use clap::Parser;
use common_base::Plugins; use common_base::Plugins;
use common_config::Configurable; use common_config::Configurable;
use common_meta::distributed_time_constants::init_distributed_time_constants;
use common_telemetry::info; use common_telemetry::info;
use common_telemetry::logging::{DEFAULT_LOGGING_DIR, TracingOptions}; use common_telemetry::logging::{DEFAULT_LOGGING_DIR, TracingOptions};
use common_version::{short_version, verbose_version}; use common_version::{short_version, verbose_version};
@@ -155,6 +154,8 @@ pub struct StartCommand {
#[clap(short, long)] #[clap(short, long)]
selector: Option<String>, selector: Option<String>,
#[clap(long)] #[clap(long)]
use_memory_store: Option<bool>,
#[clap(long)]
enable_region_failover: Option<bool>, enable_region_failover: Option<bool>,
#[clap(long)] #[clap(long)]
http_addr: Option<String>, http_addr: Option<String>,
@@ -184,6 +185,7 @@ impl Debug for StartCommand {
.field("store_addrs", &self.sanitize_store_addrs()) .field("store_addrs", &self.sanitize_store_addrs())
.field("config_file", &self.config_file) .field("config_file", &self.config_file)
.field("selector", &self.selector) .field("selector", &self.selector)
.field("use_memory_store", &self.use_memory_store)
.field("enable_region_failover", &self.enable_region_failover) .field("enable_region_failover", &self.enable_region_failover)
.field("http_addr", &self.http_addr) .field("http_addr", &self.http_addr)
.field("http_timeout", &self.http_timeout) .field("http_timeout", &self.http_timeout)
@@ -265,6 +267,10 @@ impl StartCommand {
.context(error::UnsupportedSelectorTypeSnafu { selector_type })?; .context(error::UnsupportedSelectorTypeSnafu { selector_type })?;
} }
if let Some(use_memory_store) = self.use_memory_store {
opts.use_memory_store = use_memory_store;
}
if let Some(enable_region_failover) = self.enable_region_failover { if let Some(enable_region_failover) = self.enable_region_failover {
opts.enable_region_failover = enable_region_failover; opts.enable_region_failover = enable_region_failover;
} }
@@ -321,7 +327,6 @@ impl StartCommand {
log_versions(verbose_version(), short_version(), APP_NAME); log_versions(verbose_version(), short_version(), APP_NAME);
maybe_activate_heap_profile(&opts.component.memory); maybe_activate_heap_profile(&opts.component.memory);
create_resource_limit_metrics(APP_NAME); create_resource_limit_metrics(APP_NAME);
init_distributed_time_constants(opts.component.heartbeat_interval);
info!("Metasrv start command: {:#?}", self); info!("Metasrv start command: {:#?}", self);
@@ -384,6 +389,7 @@ mod tests {
server_addr = "127.0.0.1:3002" server_addr = "127.0.0.1:3002"
store_addr = "127.0.0.1:2379" store_addr = "127.0.0.1:2379"
selector = "LeaseBased" selector = "LeaseBased"
use_memory_store = false
[logging] [logging]
level = "debug" level = "debug"
@@ -462,6 +468,7 @@ mod tests {
server_addr = "127.0.0.1:3002" server_addr = "127.0.0.1:3002"
datanode_lease_secs = 15 datanode_lease_secs = 15
selector = "LeaseBased" selector = "LeaseBased"
use_memory_store = false
[http] [http]
addr = "127.0.0.1:4000" addr = "127.0.0.1:4000"

View File

@@ -261,7 +261,7 @@ impl StartCommand {
}; };
let tls_opts = TlsOption::new( let tls_opts = TlsOption::new(
self.tls_mode, self.tls_mode.clone(),
self.tls_cert_path.clone(), self.tls_cert_path.clone(),
self.tls_key_path.clone(), self.tls_key_path.clone(),
self.tls_watch, self.tls_watch,
@@ -552,8 +552,9 @@ impl StartCommand {
let grpc_handler = fe_instance.clone() as Arc<dyn GrpcQueryHandlerWithBoxedError>; let grpc_handler = fe_instance.clone() as Arc<dyn GrpcQueryHandlerWithBoxedError>;
let weak_grpc_handler = Arc::downgrade(&grpc_handler); let weak_grpc_handler = Arc::downgrade(&grpc_handler);
frontend_instance_handler frontend_instance_handler
.set_handler(weak_grpc_handler) .lock()
.await; .unwrap()
.replace(weak_grpc_handler);
// set the frontend invoker for flownode // set the frontend invoker for flownode
let flow_streaming_engine = flownode.flow_engine().streaming_engine(); let flow_streaming_engine = flownode.flow_engine().streaming_engine();

View File

@@ -228,6 +228,7 @@ fn test_load_flownode_example_config() {
..Default::default() ..Default::default()
}, },
tracing: Default::default(), tracing: Default::default(),
heartbeat: Default::default(),
// flownode deliberately use a slower query parallelism // flownode deliberately use a slower query parallelism
// to avoid overwhelming the frontend with too many queries // to avoid overwhelming the frontend with too many queries
query: QueryOptions { query: QueryOptions {

View File

@@ -59,6 +59,15 @@ pub enum Error {
location: Location, location: Location,
}, },
#[snafu(display("Failed to canonicalize path: {}", path))]
CanonicalizePath {
path: String,
#[snafu(source)]
error: std::io::Error,
#[snafu(implicit)]
location: Location,
},
#[snafu(display("Invalid path '{}': expected a file, not a directory", path))] #[snafu(display("Invalid path '{}': expected a file, not a directory", path))]
InvalidPath { InvalidPath {
path: String, path: String,
@@ -73,7 +82,8 @@ impl ErrorExt for Error {
Error::TomlFormat { .. } Error::TomlFormat { .. }
| Error::LoadLayeredConfig { .. } | Error::LoadLayeredConfig { .. }
| Error::FileWatch { .. } | Error::FileWatch { .. }
| Error::InvalidPath { .. } => StatusCode::InvalidArguments, | Error::InvalidPath { .. }
| Error::CanonicalizePath { .. } => StatusCode::InvalidArguments,
Error::SerdeJson { .. } => StatusCode::Unexpected, Error::SerdeJson { .. } => StatusCode::Unexpected,
} }
} }

View File

@@ -30,7 +30,7 @@ use common_telemetry::{error, info, warn};
use notify::{EventKind, RecursiveMode, Watcher}; use notify::{EventKind, RecursiveMode, Watcher};
use snafu::ResultExt; use snafu::ResultExt;
use crate::error::{FileWatchSnafu, InvalidPathSnafu, Result}; use crate::error::{CanonicalizePathSnafu, FileWatchSnafu, InvalidPathSnafu, Result};
/// Configuration for the file watcher behavior. /// Configuration for the file watcher behavior.
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
@@ -41,10 +41,15 @@ pub struct FileWatcherConfig {
impl FileWatcherConfig { impl FileWatcherConfig {
pub fn new() -> Self { pub fn new() -> Self {
Default::default() Self::default()
} }
pub fn include_remove_events(mut self) -> Self { pub fn with_modify_and_create(mut self) -> Self {
self.include_remove_events = false;
self
}
pub fn with_remove_events(mut self) -> Self {
self.include_remove_events = true; self.include_remove_events = true;
self self
} }
@@ -88,8 +93,11 @@ impl FileWatcherBuilder {
path: path.display().to_string(), path: path.display().to_string(),
} }
); );
// Canonicalize the path for reliable comparison with event paths
self.file_paths.push(path.to_path_buf()); let canonical = path.canonicalize().context(CanonicalizePathSnafu {
path: path.display().to_string(),
})?;
self.file_paths.push(canonical);
Ok(self) Ok(self)
} }
@@ -136,6 +144,7 @@ impl FileWatcherBuilder {
} }
let config = self.config; let config = self.config;
let watched_files: HashSet<PathBuf> = self.file_paths.iter().cloned().collect();
info!( info!(
"Spawning file watcher for paths: {:?} (watching parent directories)", "Spawning file watcher for paths: {:?} (watching parent directories)",
@@ -156,7 +165,25 @@ impl FileWatcherBuilder {
continue; continue;
} }
info!(?event.kind, ?event.paths, "Detected folder change"); // Check if any of the event paths match our watched files
let is_watched_file = event.paths.iter().any(|event_path| {
// Try to canonicalize the event path for comparison
// If the file was deleted, canonicalize will fail, so we also
// compare the raw path
if let Ok(canonical) = event_path.canonicalize()
&& watched_files.contains(&canonical)
{
return true;
}
// For deleted files, compare using the raw path
watched_files.contains(event_path)
});
if !is_watched_file {
continue;
}
info!(?event.kind, ?event.paths, "Detected file change");
callback(); callback();
} }
Err(err) => { Err(err) => {
@@ -274,4 +301,55 @@ mod tests {
"Watcher should have detected file recreation" "Watcher should have detected file recreation"
); );
} }
#[test]
fn test_file_watcher_ignores_other_files() {
common_telemetry::init_default_ut_logging();
let dir = create_temp_dir("test_file_watcher_other");
let watched_file = dir.path().join("watched.txt");
let other_file = dir.path().join("other.txt");
// Create both files
std::fs::write(&watched_file, "watched content").unwrap();
std::fs::write(&other_file, "other content").unwrap();
let counter = Arc::new(AtomicUsize::new(0));
let counter_clone = counter.clone();
FileWatcherBuilder::new()
.watch_path(&watched_file)
.unwrap()
.config(FileWatcherConfig::new())
.spawn(move || {
counter_clone.fetch_add(1, Ordering::SeqCst);
})
.unwrap();
// Give watcher time to start
std::thread::sleep(Duration::from_millis(100));
// Modify the other file - should NOT trigger callback
std::fs::write(&other_file, "modified other content").unwrap();
// Wait for potential event
std::thread::sleep(Duration::from_millis(500));
assert_eq!(
counter.load(Ordering::SeqCst),
0,
"Watcher should not have detected changes to other files"
);
// Now modify the watched file - SHOULD trigger callback
std::fs::write(&watched_file, "modified watched content").unwrap();
// Wait for the event to be processed
std::thread::sleep(Duration::from_millis(500));
assert!(
counter.load(Ordering::SeqCst) >= 1,
"Watcher should have detected change to watched file"
);
}
} }

View File

@@ -27,7 +27,6 @@ const SECRET_ACCESS_KEY: &str = "secret_access_key";
const SESSION_TOKEN: &str = "session_token"; const SESSION_TOKEN: &str = "session_token";
const REGION: &str = "region"; const REGION: &str = "region";
const ENABLE_VIRTUAL_HOST_STYLE: &str = "enable_virtual_host_style"; const ENABLE_VIRTUAL_HOST_STYLE: &str = "enable_virtual_host_style";
const DISABLE_EC2_METADATA: &str = "disable_ec2_metadata";
pub fn is_supported_in_s3(key: &str) -> bool { pub fn is_supported_in_s3(key: &str) -> bool {
[ [
@@ -37,7 +36,6 @@ pub fn is_supported_in_s3(key: &str) -> bool {
SESSION_TOKEN, SESSION_TOKEN,
REGION, REGION,
ENABLE_VIRTUAL_HOST_STYLE, ENABLE_VIRTUAL_HOST_STYLE,
DISABLE_EC2_METADATA,
] ]
.contains(&key) .contains(&key)
} }
@@ -84,21 +82,6 @@ pub fn build_s3_backend(
} }
} }
if let Some(disable_str) = connection.get(DISABLE_EC2_METADATA) {
let disable = disable_str.as_str().parse::<bool>().map_err(|e| {
error::InvalidConnectionSnafu {
msg: format!(
"failed to parse the option {}={}, {}",
DISABLE_EC2_METADATA, disable_str, e
),
}
.build()
})?;
if disable {
builder = builder.disable_ec2_metadata();
}
}
// TODO(weny): Consider finding a better way to eliminate duplicate code. // TODO(weny): Consider finding a better way to eliminate duplicate code.
Ok(ObjectStore::new(builder) Ok(ObjectStore::new(builder)
.context(error::BuildBackendSnafu)? .context(error::BuildBackendSnafu)?
@@ -126,7 +109,6 @@ mod tests {
assert!(is_supported_in_s3(SESSION_TOKEN)); assert!(is_supported_in_s3(SESSION_TOKEN));
assert!(is_supported_in_s3(REGION)); assert!(is_supported_in_s3(REGION));
assert!(is_supported_in_s3(ENABLE_VIRTUAL_HOST_STYLE)); assert!(is_supported_in_s3(ENABLE_VIRTUAL_HOST_STYLE));
assert!(is_supported_in_s3(DISABLE_EC2_METADATA));
assert!(!is_supported_in_s3("foo")) assert!(!is_supported_in_s3("foo"))
} }
} }

View File

@@ -17,10 +17,9 @@ ahash.workspace = true
api.workspace = true api.workspace = true
arc-swap = "1.0" arc-swap = "1.0"
arrow.workspace = true arrow.workspace = true
arrow-cast.workspace = true
arrow-schema.workspace = true arrow-schema.workspace = true
async-trait.workspace = true async-trait.workspace = true
bincode = "=1.3.3" bincode = "1.3"
catalog.workspace = true catalog.workspace = true
chrono.workspace = true chrono.workspace = true
common-base.workspace = true common-base.workspace = true
@@ -47,7 +46,6 @@ geohash = { version = "0.13", optional = true }
h3o = { version = "0.6", optional = true } h3o = { version = "0.6", optional = true }
hyperloglogplus = "0.4" hyperloglogplus = "0.4"
jsonb.workspace = true jsonb.workspace = true
jsonpath-rust = "0.7.5"
memchr = "2.7" memchr = "2.7"
mito-codec.workspace = true mito-codec.workspace = true
nalgebra.workspace = true nalgebra.workspace = true

View File

@@ -13,24 +13,17 @@
// limitations under the License. // limitations under the License.
use std::fmt::{self, Display}; use std::fmt::{self, Display};
use std::str::FromStr;
use std::sync::Arc; use std::sync::Arc;
use arrow::array::{ArrayRef, BinaryViewArray, StringViewArray, StructArray};
use arrow::compute; use arrow::compute;
use arrow::datatypes::{Float64Type, Int64Type, UInt64Type}; use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{ use datafusion_common::arrow::array::{
Array, AsArray, BinaryViewBuilder, BooleanBuilder, Float64Builder, Int64Builder, Array, AsArray, BinaryViewBuilder, BooleanBuilder, Float64Builder, Int64Builder,
StringViewBuilder, StringViewBuilder,
}; };
use datafusion_common::arrow::datatypes::DataType; use datafusion_common::arrow::datatypes::DataType;
use datafusion_common::{DataFusionError, Result};
use datafusion_expr::type_coercion::aggregates::STRINGS; use datafusion_expr::type_coercion::aggregates::STRINGS;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, Volatility}; use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature};
use datatypes::arrow_array::{int_array_value_at_index, string_array_value_at_index};
use datatypes::json::JsonStructureSettings;
use jsonpath_rust::JsonPath;
use serde_json::Value;
use crate::function::{Function, extract_args}; use crate::function::{Function, extract_args};
use crate::helper; use crate::helper;
@@ -131,6 +124,13 @@ macro_rules! json_get {
}; };
} }
json_get!(
JsonGetInt,
Int64,
i64,
"Get the value from the JSONB by the given path and return it as an integer."
);
json_get!( json_get!(
JsonGetFloat, JsonGetFloat,
Float64, Float64,
@@ -145,354 +145,68 @@ json_get!(
"Get the value from the JSONB by the given path and return it as a boolean." "Get the value from the JSONB by the given path and return it as a boolean."
); );
enum JsonResultValue<'a> { /// Get the value from the JSONB by the given path and return it as a string.
Jsonb(Vec<u8>), #[derive(Clone, Debug)]
JsonStructByColumn(&'a ArrayRef, usize), pub struct JsonGetString {
JsonStructByValue(&'a Value),
}
trait JsonGetResultBuilder {
fn append_value(&mut self, value: JsonResultValue<'_>) -> Result<()>;
fn append_null(&mut self);
fn build(&mut self) -> ArrayRef;
}
/// Common implementation for JSON get scalar functions.
///
/// `JsonGet` encapsulates the logic for extracting values from JSON inputs
/// based on a path expression. Different JSON get functions reuse this
/// implementation by supplying their own `JsonGetResultBuilder` to control
/// how the resulting values are materialized into an Arrow array.
struct JsonGet {
signature: Signature, signature: Signature,
} }
impl JsonGet {
fn invoke<F, B>(&self, args: ScalarFunctionArgs, builder_factory: F) -> Result<ColumnarValue>
where
F: Fn(usize) -> B,
B: JsonGetResultBuilder,
{
let [arg0, arg1] = extract_args("JSON_GET", &args)?;
let arg1 = compute::cast(&arg1, &DataType::Utf8View)?;
let paths = arg1.as_string_view();
let mut builder = (builder_factory)(arg0.len());
match arg0.data_type() {
DataType::Binary | DataType::LargeBinary | DataType::BinaryView => {
let arg0 = compute::cast(&arg0, &DataType::BinaryView)?;
let jsons = arg0.as_binary_view();
jsonb_get(jsons, paths, &mut builder)?;
}
DataType::Struct(_) => {
let jsons = arg0.as_struct();
json_struct_get(jsons, paths, &mut builder)?
}
_ => {
return Err(DataFusionError::Execution(format!(
"JSON_GET not supported argument type {}",
arg0.data_type(),
)));
}
};
Ok(ColumnarValue::Array(builder.build()))
}
}
impl Default for JsonGet {
fn default() -> Self {
Self {
signature: Signature::any(2, Volatility::Immutable),
}
}
}
#[derive(Default)]
pub struct JsonGetString(JsonGet);
impl JsonGetString { impl JsonGetString {
pub const NAME: &'static str = "json_get_string"; pub const NAME: &'static str = "json_get_string";
} }
impl Default for JsonGetString {
fn default() -> Self {
Self {
// TODO(LFC): Use a more clear type here instead of "Binary" for Json input, once we have a "Json" type.
signature: helper::one_of_sigs2(
vec![DataType::Binary, DataType::BinaryView],
vec![DataType::Utf8, DataType::Utf8View],
),
}
}
}
impl Function for JsonGetString { impl Function for JsonGetString {
fn name(&self) -> &str { fn name(&self) -> &str {
Self::NAME Self::NAME
} }
fn return_type(&self, _: &[DataType]) -> Result<DataType> { fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::Utf8View) Ok(DataType::Utf8View)
} }
fn signature(&self) -> &Signature { fn signature(&self) -> &Signature {
&self.0.signature &self.signature
} }
fn invoke_with_args(&self, args: ScalarFunctionArgs) -> Result<ColumnarValue> { fn invoke_with_args(
struct StringResultBuilder(StringViewBuilder); &self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
let [arg0, arg1] = extract_args(self.name(), &args)?;
let arg0 = compute::cast(&arg0, &DataType::BinaryView)?;
let jsons = arg0.as_binary_view();
let arg1 = compute::cast(&arg1, &DataType::Utf8View)?;
let paths = arg1.as_string_view();
impl JsonGetResultBuilder for StringResultBuilder { let size = jsons.len();
fn append_value(&mut self, value: JsonResultValue<'_>) -> Result<()> { let mut builder = StringViewBuilder::with_capacity(size);
match value {
JsonResultValue::Jsonb(value) => { for i in 0..size {
self.0.append_option(jsonb::to_str(&value).ok()) let json = jsons.is_valid(i).then(|| jsons.value(i));
} let path = paths.is_valid(i).then(|| paths.value(i));
JsonResultValue::JsonStructByColumn(column, i) => { let result = match (json, path) {
if let Some(v) = string_array_value_at_index(column, i) { (Some(json), Some(path)) => {
self.0.append_value(v); get_json_by_path(json, path).and_then(|json| jsonb::to_str(&json).ok())
} else {
self.0
.append_value(arrow_cast::display::array_value_to_string(
column, i,
)?);
}
}
JsonResultValue::JsonStructByValue(value) => {
if let Some(s) = value.as_str() {
self.0.append_value(s)
} else {
self.0.append_value(value.to_string())
}
}
} }
Ok(()) _ => None,
}
fn append_null(&mut self) {
self.0.append_null();
}
fn build(&mut self) -> ArrayRef {
Arc::new(self.0.finish())
}
}
self.0.invoke(args, |len: usize| {
StringResultBuilder(StringViewBuilder::with_capacity(len))
})
}
}
#[derive(Default)]
pub struct JsonGetInt(JsonGet);
impl JsonGetInt {
pub const NAME: &'static str = "json_get_int";
}
impl Function for JsonGetInt {
fn name(&self) -> &str {
Self::NAME
}
fn return_type(&self, _: &[DataType]) -> Result<DataType> {
Ok(DataType::Int64)
}
fn signature(&self) -> &Signature {
&self.0.signature
}
fn invoke_with_args(&self, args: ScalarFunctionArgs) -> Result<ColumnarValue> {
struct IntResultBuilder(Int64Builder);
impl JsonGetResultBuilder for IntResultBuilder {
fn append_value(&mut self, value: JsonResultValue<'_>) -> Result<()> {
match value {
JsonResultValue::Jsonb(value) => {
self.0.append_option(jsonb::to_i64(&value).ok())
}
JsonResultValue::JsonStructByColumn(column, i) => {
self.0.append_option(int_array_value_at_index(column, i))
}
JsonResultValue::JsonStructByValue(value) => {
self.0.append_option(value.as_i64())
}
}
Ok(())
}
fn append_null(&mut self) {
self.0.append_null();
}
fn build(&mut self) -> ArrayRef {
Arc::new(self.0.finish())
}
}
self.0.invoke(args, |len: usize| {
IntResultBuilder(Int64Builder::with_capacity(len))
})
}
}
impl Display for JsonGetInt {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", Self::NAME.to_ascii_uppercase())
}
}
fn jsonb_get(
jsons: &BinaryViewArray,
paths: &StringViewArray,
builder: &mut impl JsonGetResultBuilder,
) -> Result<()> {
let size = jsons.len();
for i in 0..size {
let json = jsons.is_valid(i).then(|| jsons.value(i));
let path = paths.is_valid(i).then(|| paths.value(i));
let result = match (json, path) {
(Some(json), Some(path)) => get_json_by_path(json, path),
_ => None,
};
if let Some(v) = result {
builder.append_value(JsonResultValue::Jsonb(v))?;
} else {
builder.append_null();
}
}
Ok(())
}
fn json_struct_get(
jsons: &StructArray,
paths: &StringViewArray,
builder: &mut impl JsonGetResultBuilder,
) -> Result<()> {
let size = jsons.len();
for i in 0..size {
if jsons.is_null(i) || paths.is_null(i) {
builder.append_null();
continue;
}
let path = paths.value(i);
// naively assume the JSON path is our kind of indexing to the field, by removing its "root"
let field_path = path.trim().replace("$.", "");
let column = jsons.column_by_name(&field_path);
if let Some(column) = column {
builder.append_value(JsonResultValue::JsonStructByColumn(column, i))?;
} else {
let Some(raw) = jsons
.column_by_name(JsonStructureSettings::RAW_FIELD)
.and_then(|x| string_array_value_at_index(x, i))
else {
builder.append_null();
continue;
}; };
builder.append_option(result);
let path: JsonPath<Value> = JsonPath::try_from(path).map_err(|e| {
DataFusionError::Execution(format!("{path} is not a valid JSON path: {e}"))
})?;
// the wanted field is not retrievable from the JSON struct columns directly, we have
// to combine everything (columns and the "_raw") into a complete JSON value to find it
let value = json_struct_to_value(raw, jsons, i)?;
match path.find(&value) {
Value::Null => builder.append_null(),
Value::Array(values) => match values.as_slice() {
[] => builder.append_null(),
[x] => builder.append_value(JsonResultValue::JsonStructByValue(x))?,
_ => builder.append_value(JsonResultValue::JsonStructByValue(&value))?,
},
value => builder.append_value(JsonResultValue::JsonStructByValue(&value))?,
}
} }
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
} }
Ok(())
}
fn json_struct_to_value(raw: &str, jsons: &StructArray, i: usize) -> Result<Value> {
let Ok(mut json) = Value::from_str(raw) else {
return Err(DataFusionError::Internal(format!(
"inner field '{}' is not a valid JSON string",
JsonStructureSettings::RAW_FIELD
)));
};
for (column_name, column) in jsons.column_names().into_iter().zip(jsons.columns()) {
if column_name == JsonStructureSettings::RAW_FIELD {
continue;
}
let (json_pointer, field) = if let Some((json_object, field)) = column_name.rsplit_once(".")
{
let json_pointer = format!("/{}", json_object.replace(".", "/"));
(json_pointer, field)
} else {
("".to_string(), column_name)
};
let Some(json_object) = json
.pointer_mut(&json_pointer)
.and_then(|x| x.as_object_mut())
else {
return Err(DataFusionError::Internal(format!(
"value at JSON pointer '{}' is not an object",
json_pointer
)));
};
macro_rules! insert {
($column: ident, $i: ident, $json_object: ident, $field: ident) => {{
if let Some(value) = $column
.is_valid($i)
.then(|| serde_json::Value::from($column.value($i)))
{
$json_object.insert($field.to_string(), value);
}
}};
}
match column.data_type() {
// boolean => Value::Bool
DataType::Boolean => {
let column = column.as_boolean();
insert!(column, i, json_object, field);
}
// int => Value::Number
DataType::Int64 => {
let column = column.as_primitive::<Int64Type>();
insert!(column, i, json_object, field);
}
DataType::UInt64 => {
let column = column.as_primitive::<UInt64Type>();
insert!(column, i, json_object, field);
}
DataType::Float64 => {
let column = column.as_primitive::<Float64Type>();
insert!(column, i, json_object, field);
}
// string => Value::String
DataType::Utf8 => {
let column = column.as_string::<i32>();
insert!(column, i, json_object, field);
}
DataType::LargeUtf8 => {
let column = column.as_string::<i64>();
insert!(column, i, json_object, field);
}
DataType::Utf8View => {
let column = column.as_string_view();
insert!(column, i, json_object, field);
}
// other => Value::Array and Value::Object
_ => {
return Err(DataFusionError::NotImplemented(format!(
"{} is not yet supported to be executed with field {} of datatype {}",
JsonGetString::NAME,
column_name,
column.data_type()
)));
}
}
}
Ok(json)
} }
impl Display for JsonGetString { impl Display for JsonGetString {
@@ -582,60 +296,14 @@ impl Display for JsonGetObject {
mod tests { mod tests {
use std::sync::Arc; use std::sync::Arc;
use arrow::array::{Float64Array, Int64Array, StructArray};
use arrow_schema::Field; use arrow_schema::Field;
use datafusion_common::ScalarValue; use datafusion_common::ScalarValue;
use datafusion_common::arrow::array::{BinaryArray, BinaryViewArray, StringArray}; use datafusion_common::arrow::array::{BinaryArray, BinaryViewArray, StringArray};
use datafusion_common::arrow::datatypes::{Float64Type, Int64Type}; use datafusion_common::arrow::datatypes::{Float64Type, Int64Type};
use datatypes::types::parse_string_to_jsonb; use datatypes::types::parse_string_to_jsonb;
use serde_json::json;
use super::*; use super::*;
/// Create a JSON object like this (as a one element struct array for testing):
///
/// ```JSON
/// {
/// "kind": "foo",
/// "payload": {
/// "code": 404,
/// "success": false,
/// "result": {
/// "error": "not found",
/// "time_cost": 1.234
/// }
/// }
/// }
/// ```
fn test_json_struct() -> ArrayRef {
Arc::new(StructArray::new(
vec![
Field::new("kind", DataType::Utf8, true),
Field::new("payload.code", DataType::Int64, true),
Field::new("payload.result.time_cost", DataType::Float64, true),
Field::new(JsonStructureSettings::RAW_FIELD, DataType::Utf8View, true),
]
.into(),
vec![
Arc::new(StringArray::from_iter([Some("foo")])) as ArrayRef,
Arc::new(Int64Array::from_iter([Some(404)])),
Arc::new(Float64Array::from_iter([Some(1.234)])),
Arc::new(StringViewArray::from_iter([Some(
json! ({
"payload": {
"success": false,
"result": {
"error": "not found"
}
}
})
.to_string(),
)])),
],
None,
))
}
#[test] #[test]
fn test_json_get_int() { fn test_json_get_int() {
let json_get_int = JsonGetInt::default(); let json_get_int = JsonGetInt::default();
@@ -653,55 +321,37 @@ mod tests {
r#"{"a": 4, "b": {"c": 6}, "c": 6}"#, r#"{"a": 4, "b": {"c": 6}, "c": 6}"#,
r#"{"a": 7, "b": 8, "c": {"a": 7}}"#, r#"{"a": 7, "b": 8, "c": {"a": 7}}"#,
]; ];
let json_struct = test_json_struct(); let paths = vec!["$.a.b", "$.a", "$.c"];
let results = [Some(2), Some(4), None];
let path_expects = vec![ let jsonbs = json_strings
("$.a.b", Some(2)),
("$.a", Some(4)),
("$.c", None),
("$.kind", None),
("$.payload.code", Some(404)),
("$.payload.success", None),
("$.payload.result.time_cost", None),
("$.payload.not-exists", None),
("$.not-exists", None),
("$", None),
];
let mut jsons = json_strings
.iter() .iter()
.map(|s| { .map(|s| {
let value = jsonb::parse_value(s.as_bytes()).unwrap(); let value = jsonb::parse_value(s.as_bytes()).unwrap();
Arc::new(BinaryArray::from_iter_values([value.to_vec()])) as ArrayRef value.to_vec()
}) })
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let json_struct_arrays =
std::iter::repeat_n(json_struct, path_expects.len() - jsons.len()).collect::<Vec<_>>();
jsons.extend(json_struct_arrays);
for i in 0..jsons.len() { let args = ScalarFunctionArgs {
let json = &jsons[i]; args: vec![
let (path, expect) = path_expects[i]; ColumnarValue::Array(Arc::new(BinaryArray::from_iter_values(jsonbs))),
ColumnarValue::Array(Arc::new(StringArray::from_iter_values(paths))),
],
arg_fields: vec![],
number_rows: 3,
return_field: Arc::new(Field::new("x", DataType::Int64, false)),
config_options: Arc::new(Default::default()),
};
let result = json_get_int
.invoke_with_args(args)
.and_then(|x| x.to_array(3))
.unwrap();
let vector = result.as_primitive::<Int64Type>();
let args = ScalarFunctionArgs { assert_eq!(3, vector.len());
args: vec![ for (i, gt) in results.iter().enumerate() {
ColumnarValue::Array(json.clone()), let result = vector.is_valid(i).then(|| vector.value(i));
ColumnarValue::Scalar(path.into()), assert_eq!(*gt, result);
],
arg_fields: vec![],
number_rows: 1,
return_field: Arc::new(Field::new("x", DataType::Int64, false)),
config_options: Arc::new(Default::default()),
};
let result = json_get_int
.invoke_with_args(args)
.and_then(|x| x.to_array(1))
.unwrap();
let result = result.as_primitive::<Int64Type>();
assert_eq!(1, result.len());
let actual = result.is_valid(0).then(|| result.value(0));
assert_eq!(actual, expect);
} }
} }
@@ -824,85 +474,42 @@ mod tests {
r#"{"a": "d", "b": {"c": "e"}, "c": "f"}"#, r#"{"a": "d", "b": {"c": "e"}, "c": "f"}"#,
r#"{"a": "g", "b": "h", "c": {"a": "g"}}"#, r#"{"a": "g", "b": "h", "c": {"a": "g"}}"#,
]; ];
let json_struct = test_json_struct(); let paths = vec!["$.a.b", "$.a", ""];
let results = [Some("a"), Some("d"), None];
let paths = vec![ let jsonbs = json_strings
"$.a.b",
"$.a",
"",
"$.kind",
"$.payload.code",
"$.payload.result.time_cost",
"$.payload",
"$.payload.success",
"$.payload.result",
"$.payload.result.error",
"$.payload.result.not-exists",
"$.payload.not-exists",
"$.not-exists",
"$",
];
let expects = [
Some("a"),
Some("d"),
None,
Some("foo"),
Some("404"),
Some("1.234"),
Some(
r#"{"code":404,"result":{"error":"not found","time_cost":1.234},"success":false}"#,
),
Some("false"),
Some(r#"{"error":"not found","time_cost":1.234}"#),
Some("not found"),
None,
None,
None,
Some(
r#"{"kind":"foo","payload":{"code":404,"result":{"error":"not found","time_cost":1.234},"success":false}}"#,
),
];
let mut jsons = json_strings
.iter() .iter()
.map(|s| { .map(|s| {
let value = jsonb::parse_value(s.as_bytes()).unwrap(); let value = jsonb::parse_value(s.as_bytes()).unwrap();
Arc::new(BinaryArray::from_iter_values([value.to_vec()])) as ArrayRef value.to_vec()
}) })
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let json_struct_arrays =
std::iter::repeat_n(json_struct, expects.len() - jsons.len()).collect::<Vec<_>>();
jsons.extend(json_struct_arrays);
for i in 0..jsons.len() { let args = ScalarFunctionArgs {
let json = &jsons[i]; args: vec![
let path = paths[i]; ColumnarValue::Array(Arc::new(BinaryArray::from_iter_values(jsonbs))),
let expect = expects[i]; ColumnarValue::Array(Arc::new(StringArray::from_iter_values(paths))),
],
arg_fields: vec![],
number_rows: 3,
return_field: Arc::new(Field::new("x", DataType::Utf8View, false)),
config_options: Arc::new(Default::default()),
};
let result = json_get_string
.invoke_with_args(args)
.and_then(|x| x.to_array(3))
.unwrap();
let vector = result.as_string_view();
let args = ScalarFunctionArgs { assert_eq!(3, vector.len());
args: vec![ for (i, gt) in results.iter().enumerate() {
ColumnarValue::Array(json.clone()), let result = vector.is_valid(i).then(|| vector.value(i));
ColumnarValue::Scalar(path.into()), assert_eq!(*gt, result);
],
arg_fields: vec![],
number_rows: 1,
return_field: Arc::new(Field::new("x", DataType::Utf8View, false)),
config_options: Arc::new(Default::default()),
};
let result = json_get_string
.invoke_with_args(args)
.and_then(|x| x.to_array(1))
.unwrap();
let result = result.as_string_view();
assert_eq!(1, result.len());
let actual = result.is_valid(0).then(|| result.value(0));
assert_eq!(actual, expect);
} }
} }
#[test] #[test]
fn test_json_get_object() -> Result<()> { fn test_json_get_object() -> datafusion_common::Result<()> {
let udf = JsonGetObject::default(); let udf = JsonGetObject::default();
assert_eq!("json_get_object", udf.name()); assert_eq!("json_get_object", udf.name());
assert_eq!( assert_eq!(

View File

@@ -14,31 +14,13 @@
//! String scalar functions //! String scalar functions
mod elt;
mod field;
mod format;
mod insert;
mod locate;
mod regexp_extract; mod regexp_extract;
mod space;
pub(crate) use elt::EltFunction;
pub(crate) use field::FieldFunction;
pub(crate) use format::FormatFunction;
pub(crate) use insert::InsertFunction;
pub(crate) use locate::LocateFunction;
pub(crate) use regexp_extract::RegexpExtractFunction; pub(crate) use regexp_extract::RegexpExtractFunction;
pub(crate) use space::SpaceFunction;
use crate::function_registry::FunctionRegistry; use crate::function_registry::FunctionRegistry;
/// Register all string functions /// Register all string functions
pub fn register_string_functions(registry: &FunctionRegistry) { pub fn register_string_functions(registry: &FunctionRegistry) {
EltFunction::register(registry);
FieldFunction::register(registry);
FormatFunction::register(registry);
InsertFunction::register(registry);
LocateFunction::register(registry);
RegexpExtractFunction::register(registry); RegexpExtractFunction::register(registry);
SpaceFunction::register(registry);
} }

View File

@@ -1,252 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
//! MySQL-compatible ELT function implementation.
//!
//! ELT(N, str1, str2, str3, ...) - Returns the Nth string from the list.
//! Returns NULL if N < 1 or N > number of strings.
use std::fmt;
use std::sync::Arc;
use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{Array, ArrayRef, AsArray, LargeStringBuilder};
use datafusion_common::arrow::compute::cast;
use datafusion_common::arrow::datatypes::DataType;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, Volatility};
use crate::function::Function;
use crate::function_registry::FunctionRegistry;
const NAME: &str = "elt";
/// MySQL-compatible ELT function.
///
/// Syntax: ELT(N, str1, str2, str3, ...)
/// Returns the Nth string argument. N is 1-based.
/// Returns NULL if N is NULL, N < 1, or N > number of string arguments.
#[derive(Debug)]
pub struct EltFunction {
signature: Signature,
}
impl EltFunction {
pub fn register(registry: &FunctionRegistry) {
registry.register_scalar(EltFunction::default());
}
}
impl Default for EltFunction {
fn default() -> Self {
Self {
// ELT takes a variable number of arguments: (Int64, String, String, ...)
signature: Signature::variadic_any(Volatility::Immutable),
}
}
}
impl fmt::Display for EltFunction {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", NAME.to_ascii_uppercase())
}
}
impl Function for EltFunction {
fn name(&self) -> &str {
NAME
}
fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::LargeUtf8)
}
fn signature(&self) -> &Signature {
&self.signature
}
fn invoke_with_args(
&self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
if args.args.len() < 2 {
return Err(DataFusionError::Execution(
"ELT requires at least 2 arguments: ELT(N, str1, ...)".to_string(),
));
}
let arrays = ColumnarValue::values_to_arrays(&args.args)?;
let len = arrays[0].len();
let num_strings = arrays.len() - 1;
// First argument is the index (N) - try to cast to Int64
let index_array = if arrays[0].data_type() == &DataType::Null {
// All NULLs - return all NULLs
let mut builder = LargeStringBuilder::with_capacity(len, 0);
for _ in 0..len {
builder.append_null();
}
return Ok(ColumnarValue::Array(Arc::new(builder.finish())));
} else {
cast(arrays[0].as_ref(), &DataType::Int64).map_err(|e| {
DataFusionError::Execution(format!("ELT: index argument cast failed: {}", e))
})?
};
// Cast string arguments to LargeUtf8
let string_arrays: Vec<ArrayRef> = arrays[1..]
.iter()
.enumerate()
.map(|(i, arr)| {
cast(arr.as_ref(), &DataType::LargeUtf8).map_err(|e| {
DataFusionError::Execution(format!(
"ELT: string argument {} cast failed: {}",
i + 1,
e
))
})
})
.collect::<datafusion_common::Result<Vec<_>>>()?;
let mut builder = LargeStringBuilder::with_capacity(len, len * 32);
for i in 0..len {
if index_array.is_null(i) {
builder.append_null();
continue;
}
let n = index_array
.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>()
.value(i);
// N is 1-based, check bounds
if n < 1 || n as usize > num_strings {
builder.append_null();
continue;
}
let str_idx = (n - 1) as usize;
let str_array = string_arrays[str_idx].as_string::<i64>();
if str_array.is_null(i) {
builder.append_null();
} else {
builder.append_value(str_array.value(i));
}
}
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use datafusion_common::arrow::array::{Int64Array, StringArray};
use datafusion_common::arrow::datatypes::Field;
use datafusion_expr::ScalarFunctionArgs;
use super::*;
fn create_args(arrays: Vec<ArrayRef>) -> ScalarFunctionArgs {
let arg_fields: Vec<_> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
Arc::new(Field::new(
format!("arg_{}", i),
arr.data_type().clone(),
true,
))
})
.collect();
ScalarFunctionArgs {
args: arrays.iter().cloned().map(ColumnarValue::Array).collect(),
arg_fields,
return_field: Arc::new(Field::new("result", DataType::LargeUtf8, true)),
number_rows: arrays[0].len(),
config_options: Arc::new(datafusion_common::config::ConfigOptions::default()),
}
}
#[test]
fn test_elt_basic() {
let function = EltFunction::default();
let n = Arc::new(Int64Array::from(vec![1, 2, 3]));
let s1 = Arc::new(StringArray::from(vec!["a", "a", "a"]));
let s2 = Arc::new(StringArray::from(vec!["b", "b", "b"]));
let s3 = Arc::new(StringArray::from(vec!["c", "c", "c"]));
let args = create_args(vec![n, s1, s2, s3]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "a");
assert_eq!(str_array.value(1), "b");
assert_eq!(str_array.value(2), "c");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_elt_out_of_bounds() {
let function = EltFunction::default();
let n = Arc::new(Int64Array::from(vec![0, 4, -1]));
let s1 = Arc::new(StringArray::from(vec!["a", "a", "a"]));
let s2 = Arc::new(StringArray::from(vec!["b", "b", "b"]));
let s3 = Arc::new(StringArray::from(vec!["c", "c", "c"]));
let args = create_args(vec![n, s1, s2, s3]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert!(str_array.is_null(0)); // 0 is out of bounds
assert!(str_array.is_null(1)); // 4 is out of bounds
assert!(str_array.is_null(2)); // -1 is out of bounds
} else {
panic!("Expected array result");
}
}
#[test]
fn test_elt_with_nulls() {
let function = EltFunction::default();
// Row 0: n=1, select s1="a" -> "a"
// Row 1: n=NULL -> NULL
// Row 2: n=1, select s1=NULL -> NULL
let n = Arc::new(Int64Array::from(vec![Some(1), None, Some(1)]));
let s1 = Arc::new(StringArray::from(vec![Some("a"), Some("a"), None]));
let s2 = Arc::new(StringArray::from(vec![Some("b"), Some("b"), Some("b")]));
let args = create_args(vec![n, s1, s2]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "a");
assert!(str_array.is_null(1)); // N is NULL
assert!(str_array.is_null(2)); // Selected string is NULL
} else {
panic!("Expected array result");
}
}
}

View File

@@ -1,224 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
//! MySQL-compatible FIELD function implementation.
//!
//! FIELD(str, str1, str2, str3, ...) - Returns the 1-based index of str in the list.
//! Returns 0 if str is not found or is NULL.
use std::fmt;
use std::sync::Arc;
use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{Array, ArrayRef, AsArray, Int64Builder};
use datafusion_common::arrow::compute::cast;
use datafusion_common::arrow::datatypes::DataType;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, Volatility};
use crate::function::Function;
use crate::function_registry::FunctionRegistry;
const NAME: &str = "field";
/// MySQL-compatible FIELD function.
///
/// Syntax: FIELD(str, str1, str2, str3, ...)
/// Returns the 1-based index of str in the argument list (str1, str2, str3, ...).
/// Returns 0 if str is not found or is NULL.
#[derive(Debug)]
pub struct FieldFunction {
signature: Signature,
}
impl FieldFunction {
pub fn register(registry: &FunctionRegistry) {
registry.register_scalar(FieldFunction::default());
}
}
impl Default for FieldFunction {
fn default() -> Self {
Self {
// FIELD takes a variable number of arguments: (String, String, String, ...)
signature: Signature::variadic_any(Volatility::Immutable),
}
}
}
impl fmt::Display for FieldFunction {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", NAME.to_ascii_uppercase())
}
}
impl Function for FieldFunction {
fn name(&self) -> &str {
NAME
}
fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::Int64)
}
fn signature(&self) -> &Signature {
&self.signature
}
fn invoke_with_args(
&self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
if args.args.len() < 2 {
return Err(DataFusionError::Execution(
"FIELD requires at least 2 arguments: FIELD(str, str1, ...)".to_string(),
));
}
let arrays = ColumnarValue::values_to_arrays(&args.args)?;
let len = arrays[0].len();
// Cast all arguments to LargeUtf8
let string_arrays: Vec<ArrayRef> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
cast(arr.as_ref(), &DataType::LargeUtf8).map_err(|e| {
DataFusionError::Execution(format!("FIELD: argument {} cast failed: {}", i, e))
})
})
.collect::<datafusion_common::Result<Vec<_>>>()?;
let search_str = string_arrays[0].as_string::<i64>();
let mut builder = Int64Builder::with_capacity(len);
for i in 0..len {
// If search string is NULL, return 0
if search_str.is_null(i) {
builder.append_value(0);
continue;
}
let needle = search_str.value(i);
let mut found_idx = 0i64;
// Search through the list (starting from index 1 in string_arrays)
for (j, str_arr) in string_arrays[1..].iter().enumerate() {
let str_array = str_arr.as_string::<i64>();
if !str_array.is_null(i) && str_array.value(i) == needle {
found_idx = (j + 1) as i64; // 1-based index
break;
}
}
builder.append_value(found_idx);
}
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use datafusion_common::arrow::array::StringArray;
use datafusion_common::arrow::datatypes::Field;
use datafusion_expr::ScalarFunctionArgs;
use super::*;
fn create_args(arrays: Vec<ArrayRef>) -> ScalarFunctionArgs {
let arg_fields: Vec<_> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
Arc::new(Field::new(
format!("arg_{}", i),
arr.data_type().clone(),
true,
))
})
.collect();
ScalarFunctionArgs {
args: arrays.iter().cloned().map(ColumnarValue::Array).collect(),
arg_fields,
return_field: Arc::new(Field::new("result", DataType::Int64, true)),
number_rows: arrays[0].len(),
config_options: Arc::new(datafusion_common::config::ConfigOptions::default()),
}
}
#[test]
fn test_field_basic() {
let function = FieldFunction::default();
let search = Arc::new(StringArray::from(vec!["b", "d", "a"]));
let s1 = Arc::new(StringArray::from(vec!["a", "a", "a"]));
let s2 = Arc::new(StringArray::from(vec!["b", "b", "b"]));
let s3 = Arc::new(StringArray::from(vec!["c", "c", "c"]));
let args = create_args(vec![search, s1, s2, s3]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 2); // "b" is at index 2
assert_eq!(int_array.value(1), 0); // "d" not found
assert_eq!(int_array.value(2), 1); // "a" is at index 1
} else {
panic!("Expected array result");
}
}
#[test]
fn test_field_with_null_search() {
let function = FieldFunction::default();
let search = Arc::new(StringArray::from(vec![Some("a"), None]));
let s1 = Arc::new(StringArray::from(vec!["a", "a"]));
let s2 = Arc::new(StringArray::from(vec!["b", "b"]));
let args = create_args(vec![search, s1, s2]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 1); // "a" found at index 1
assert_eq!(int_array.value(1), 0); // NULL search returns 0
} else {
panic!("Expected array result");
}
}
#[test]
fn test_field_case_sensitive() {
let function = FieldFunction::default();
let search = Arc::new(StringArray::from(vec!["A", "a"]));
let s1 = Arc::new(StringArray::from(vec!["a", "a"]));
let s2 = Arc::new(StringArray::from(vec!["A", "A"]));
let args = create_args(vec![search, s1, s2]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 2); // "A" matches at index 2
assert_eq!(int_array.value(1), 1); // "a" matches at index 1
} else {
panic!("Expected array result");
}
}
}

View File

@@ -1,512 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
//! MySQL-compatible FORMAT function implementation.
//!
//! FORMAT(X, D) - Formats the number X with D decimal places using thousand separators.
use std::fmt;
use std::sync::Arc;
use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{Array, AsArray, LargeStringBuilder};
use datafusion_common::arrow::datatypes as arrow_types;
use datafusion_common::arrow::datatypes::DataType;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, TypeSignature, Volatility};
use crate::function::Function;
use crate::function_registry::FunctionRegistry;
const NAME: &str = "format";
/// MySQL-compatible FORMAT function.
///
/// Syntax: FORMAT(X, D)
/// Formats the number X to a format like '#,###,###.##', rounded to D decimal places.
/// D can be 0 to 30.
///
/// Note: This implementation uses the en_US locale (comma as thousand separator,
/// period as decimal separator).
#[derive(Debug)]
pub struct FormatFunction {
signature: Signature,
}
impl FormatFunction {
pub fn register(registry: &FunctionRegistry) {
registry.register_scalar(FormatFunction::default());
}
}
impl Default for FormatFunction {
fn default() -> Self {
let mut signatures = Vec::new();
// Support various numeric types for X
let numeric_types = [
DataType::Float64,
DataType::Float32,
DataType::Int64,
DataType::Int32,
DataType::Int16,
DataType::Int8,
DataType::UInt64,
DataType::UInt32,
DataType::UInt16,
DataType::UInt8,
];
// D can be various integer types
let int_types = [
DataType::Int64,
DataType::Int32,
DataType::Int16,
DataType::Int8,
DataType::UInt64,
DataType::UInt32,
DataType::UInt16,
DataType::UInt8,
];
for x_type in &numeric_types {
for d_type in &int_types {
signatures.push(TypeSignature::Exact(vec![x_type.clone(), d_type.clone()]));
}
}
Self {
signature: Signature::one_of(signatures, Volatility::Immutable),
}
}
}
impl fmt::Display for FormatFunction {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", NAME.to_ascii_uppercase())
}
}
impl Function for FormatFunction {
fn name(&self) -> &str {
NAME
}
fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::LargeUtf8)
}
fn signature(&self) -> &Signature {
&self.signature
}
fn invoke_with_args(
&self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
if args.args.len() != 2 {
return Err(DataFusionError::Execution(
"FORMAT requires exactly 2 arguments: FORMAT(X, D)".to_string(),
));
}
let arrays = ColumnarValue::values_to_arrays(&args.args)?;
let len = arrays[0].len();
let x_array = &arrays[0];
let d_array = &arrays[1];
let mut builder = LargeStringBuilder::with_capacity(len, len * 20);
for i in 0..len {
if x_array.is_null(i) || d_array.is_null(i) {
builder.append_null();
continue;
}
let decimal_places = get_decimal_places(d_array, i)?.clamp(0, 30) as usize;
let formatted = match x_array.data_type() {
DataType::Float64 | DataType::Float32 => {
format_number_float(get_float_value(x_array, i)?, decimal_places)
}
DataType::Int64
| DataType::Int32
| DataType::Int16
| DataType::Int8
| DataType::UInt64
| DataType::UInt32
| DataType::UInt16
| DataType::UInt8 => format_number_integer(x_array, i, decimal_places)?,
_ => {
return Err(DataFusionError::Execution(format!(
"FORMAT: unsupported type {:?}",
x_array.data_type()
)));
}
};
builder.append_value(&formatted);
}
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
}
}
/// Get float value from various numeric types.
fn get_float_value(
array: &datafusion_common::arrow::array::ArrayRef,
index: usize,
) -> datafusion_common::Result<f64> {
match array.data_type() {
DataType::Float64 => Ok(array
.as_primitive::<arrow_types::Float64Type>()
.value(index)),
DataType::Float32 => Ok(array
.as_primitive::<arrow_types::Float32Type>()
.value(index) as f64),
_ => Err(DataFusionError::Execution(format!(
"FORMAT: unsupported type {:?}",
array.data_type()
))),
}
}
/// Get decimal places from various integer types.
///
/// MySQL clamps decimal places to `0..=30`. This function returns an `i64` so the caller can clamp.
fn get_decimal_places(
array: &datafusion_common::arrow::array::ArrayRef,
index: usize,
) -> datafusion_common::Result<i64> {
match array.data_type() {
DataType::Int64 => Ok(array.as_primitive::<arrow_types::Int64Type>().value(index)),
DataType::Int32 => Ok(array.as_primitive::<arrow_types::Int32Type>().value(index) as i64),
DataType::Int16 => Ok(array.as_primitive::<arrow_types::Int16Type>().value(index) as i64),
DataType::Int8 => Ok(array.as_primitive::<arrow_types::Int8Type>().value(index) as i64),
DataType::UInt64 => {
let v = array.as_primitive::<arrow_types::UInt64Type>().value(index);
Ok(if v > i64::MAX as u64 {
i64::MAX
} else {
v as i64
})
}
DataType::UInt32 => Ok(array.as_primitive::<arrow_types::UInt32Type>().value(index) as i64),
DataType::UInt16 => Ok(array.as_primitive::<arrow_types::UInt16Type>().value(index) as i64),
DataType::UInt8 => Ok(array.as_primitive::<arrow_types::UInt8Type>().value(index) as i64),
_ => Err(DataFusionError::Execution(format!(
"FORMAT: unsupported type {:?}",
array.data_type()
))),
}
}
fn format_number_integer(
array: &datafusion_common::arrow::array::ArrayRef,
index: usize,
decimal_places: usize,
) -> datafusion_common::Result<String> {
let (is_negative, abs_digits) = match array.data_type() {
DataType::Int64 => {
let v = array.as_primitive::<arrow_types::Int64Type>().value(index) as i128;
(v.is_negative(), v.unsigned_abs().to_string())
}
DataType::Int32 => {
let v = array.as_primitive::<arrow_types::Int32Type>().value(index) as i128;
(v.is_negative(), v.unsigned_abs().to_string())
}
DataType::Int16 => {
let v = array.as_primitive::<arrow_types::Int16Type>().value(index) as i128;
(v.is_negative(), v.unsigned_abs().to_string())
}
DataType::Int8 => {
let v = array.as_primitive::<arrow_types::Int8Type>().value(index) as i128;
(v.is_negative(), v.unsigned_abs().to_string())
}
DataType::UInt64 => {
let v = array.as_primitive::<arrow_types::UInt64Type>().value(index) as u128;
(false, v.to_string())
}
DataType::UInt32 => {
let v = array.as_primitive::<arrow_types::UInt32Type>().value(index) as u128;
(false, v.to_string())
}
DataType::UInt16 => {
let v = array.as_primitive::<arrow_types::UInt16Type>().value(index) as u128;
(false, v.to_string())
}
DataType::UInt8 => {
let v = array.as_primitive::<arrow_types::UInt8Type>().value(index) as u128;
(false, v.to_string())
}
_ => {
return Err(DataFusionError::Execution(format!(
"FORMAT: unsupported type {:?}",
array.data_type()
)));
}
};
let mut result = String::new();
if is_negative {
result.push('-');
}
result.push_str(&add_thousand_separators(&abs_digits));
if decimal_places > 0 {
result.push('.');
result.push_str(&"0".repeat(decimal_places));
}
Ok(result)
}
/// Format a float with thousand separators and `decimal_places` digits after decimal point.
fn format_number_float(x: f64, decimal_places: usize) -> String {
// Handle special cases
if x.is_nan() {
return "NaN".to_string();
}
if x.is_infinite() {
return if x.is_sign_positive() {
"Infinity".to_string()
} else {
"-Infinity".to_string()
};
}
// Round to decimal_places
let multiplier = 10f64.powi(decimal_places as i32);
let rounded = (x * multiplier).round() / multiplier;
// Split into integer and fractional parts
let is_negative = rounded < 0.0;
let abs_value = rounded.abs();
// Format with the specified decimal places
let formatted = if decimal_places == 0 {
format!("{:.0}", abs_value)
} else {
format!("{:.prec$}", abs_value, prec = decimal_places)
};
// Split at decimal point
let parts: Vec<&str> = formatted.split('.').collect();
let int_part = parts[0];
let dec_part = parts.get(1).copied();
// Add thousand separators to integer part
let int_with_sep = add_thousand_separators(int_part);
// Build result
let mut result = String::new();
if is_negative {
result.push('-');
}
result.push_str(&int_with_sep);
if let Some(dec) = dec_part {
result.push('.');
result.push_str(dec);
}
result
}
/// Add thousand separators (commas) to an integer string.
fn add_thousand_separators(s: &str) -> String {
let chars: Vec<char> = s.chars().collect();
let len = chars.len();
if len <= 3 {
return s.to_string();
}
let mut result = String::with_capacity(len + len / 3);
let first_group_len = len % 3;
let first_group_len = if first_group_len == 0 {
3
} else {
first_group_len
};
for (i, ch) in chars.iter().enumerate() {
if i > 0 && i >= first_group_len && (i - first_group_len) % 3 == 0 {
result.push(',');
}
result.push(*ch);
}
result
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use datafusion_common::arrow::array::{Float64Array, Int64Array};
use datafusion_common::arrow::datatypes::Field;
use datafusion_expr::ScalarFunctionArgs;
use super::*;
fn create_args(arrays: Vec<datafusion_common::arrow::array::ArrayRef>) -> ScalarFunctionArgs {
let arg_fields: Vec<_> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
Arc::new(Field::new(
format!("arg_{}", i),
arr.data_type().clone(),
true,
))
})
.collect();
ScalarFunctionArgs {
args: arrays.iter().cloned().map(ColumnarValue::Array).collect(),
arg_fields,
return_field: Arc::new(Field::new("result", DataType::LargeUtf8, true)),
number_rows: arrays[0].len(),
config_options: Arc::new(datafusion_common::config::ConfigOptions::default()),
}
}
#[test]
fn test_format_basic() {
let function = FormatFunction::default();
let x = Arc::new(Float64Array::from(vec![1234567.891, 1234.5, 1234567.0]));
let d = Arc::new(Int64Array::from(vec![2, 0, 3]));
let args = create_args(vec![x, d]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "1,234,567.89");
assert_eq!(str_array.value(1), "1,235"); // rounded
assert_eq!(str_array.value(2), "1,234,567.000");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_format_negative() {
let function = FormatFunction::default();
let x = Arc::new(Float64Array::from(vec![-1234567.891]));
let d = Arc::new(Int64Array::from(vec![2]));
let args = create_args(vec![x, d]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "-1,234,567.89");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_format_small_numbers() {
let function = FormatFunction::default();
let x = Arc::new(Float64Array::from(vec![0.5, 12.345, 123.0]));
let d = Arc::new(Int64Array::from(vec![2, 2, 0]));
let args = create_args(vec![x, d]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "0.50");
assert_eq!(str_array.value(1), "12.35"); // rounded
assert_eq!(str_array.value(2), "123");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_format_with_nulls() {
let function = FormatFunction::default();
let x = Arc::new(Float64Array::from(vec![Some(1234.5), None]));
let d = Arc::new(Int64Array::from(vec![2, 2]));
let args = create_args(vec![x, d]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "1,234.50");
assert!(str_array.is_null(1));
} else {
panic!("Expected array result");
}
}
#[test]
fn test_add_thousand_separators() {
assert_eq!(add_thousand_separators("1"), "1");
assert_eq!(add_thousand_separators("12"), "12");
assert_eq!(add_thousand_separators("123"), "123");
assert_eq!(add_thousand_separators("1234"), "1,234");
assert_eq!(add_thousand_separators("12345"), "12,345");
assert_eq!(add_thousand_separators("123456"), "123,456");
assert_eq!(add_thousand_separators("1234567"), "1,234,567");
assert_eq!(add_thousand_separators("12345678"), "12,345,678");
assert_eq!(add_thousand_separators("123456789"), "123,456,789");
}
#[test]
fn test_format_large_int_no_float_precision_loss() {
let function = FormatFunction::default();
// 2^53 + 1 cannot be represented exactly as f64.
let x = Arc::new(Int64Array::from(vec![9_007_199_254_740_993i64]));
let d = Arc::new(Int64Array::from(vec![0]));
let args = create_args(vec![x, d]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "9,007,199,254,740,993");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_format_decimal_places_u64_overflow_clamps() {
use datafusion_common::arrow::array::UInt64Array;
let function = FormatFunction::default();
let x = Arc::new(Int64Array::from(vec![1]));
let d = Arc::new(UInt64Array::from(vec![u64::MAX]));
let args = create_args(vec![x, d]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), format!("1.{}", "0".repeat(30)));
} else {
panic!("Expected array result");
}
}
}

View File

@@ -1,345 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
//! MySQL-compatible INSERT function implementation.
//!
//! INSERT(str, pos, len, newstr) - Inserts newstr into str at position pos,
//! replacing len characters.
use std::fmt;
use std::sync::Arc;
use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{Array, ArrayRef, AsArray, LargeStringBuilder};
use datafusion_common::arrow::compute::cast;
use datafusion_common::arrow::datatypes::DataType;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, TypeSignature, Volatility};
use crate::function::Function;
use crate::function_registry::FunctionRegistry;
const NAME: &str = "insert";
/// MySQL-compatible INSERT function.
///
/// Syntax: INSERT(str, pos, len, newstr)
/// Returns str with the substring beginning at position pos and len characters long
/// replaced by newstr.
///
/// - pos is 1-based
/// - If pos is out of range, returns the original string
/// - If len is out of range, replaces from pos to end of string
#[derive(Debug)]
pub struct InsertFunction {
signature: Signature,
}
impl InsertFunction {
pub fn register(registry: &FunctionRegistry) {
registry.register_scalar(InsertFunction::default());
}
}
impl Default for InsertFunction {
fn default() -> Self {
let mut signatures = Vec::new();
let string_types = [DataType::Utf8, DataType::LargeUtf8, DataType::Utf8View];
let int_types = [
DataType::Int64,
DataType::Int32,
DataType::Int16,
DataType::Int8,
DataType::UInt64,
DataType::UInt32,
DataType::UInt16,
DataType::UInt8,
];
for str_type in &string_types {
for newstr_type in &string_types {
for pos_type in &int_types {
for len_type in &int_types {
signatures.push(TypeSignature::Exact(vec![
str_type.clone(),
pos_type.clone(),
len_type.clone(),
newstr_type.clone(),
]));
}
}
}
}
Self {
signature: Signature::one_of(signatures, Volatility::Immutable),
}
}
}
impl fmt::Display for InsertFunction {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", NAME.to_ascii_uppercase())
}
}
impl Function for InsertFunction {
fn name(&self) -> &str {
NAME
}
fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::LargeUtf8)
}
fn signature(&self) -> &Signature {
&self.signature
}
fn invoke_with_args(
&self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
if args.args.len() != 4 {
return Err(DataFusionError::Execution(
"INSERT requires exactly 4 arguments: INSERT(str, pos, len, newstr)".to_string(),
));
}
let arrays = ColumnarValue::values_to_arrays(&args.args)?;
let len = arrays[0].len();
// Cast string arguments to LargeUtf8
let str_array = cast_to_large_utf8(&arrays[0], "str")?;
let newstr_array = cast_to_large_utf8(&arrays[3], "newstr")?;
let pos_array = cast_to_int64(&arrays[1], "pos")?;
let replace_len_array = cast_to_int64(&arrays[2], "len")?;
let str_arr = str_array.as_string::<i64>();
let pos_arr = pos_array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
let len_arr =
replace_len_array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
let newstr_arr = newstr_array.as_string::<i64>();
let mut builder = LargeStringBuilder::with_capacity(len, len * 32);
for i in 0..len {
// Check for NULLs
if str_arr.is_null(i)
|| pos_array.is_null(i)
|| replace_len_array.is_null(i)
|| newstr_arr.is_null(i)
{
builder.append_null();
continue;
}
let original = str_arr.value(i);
let pos = pos_arr.value(i);
let replace_len = len_arr.value(i);
let new_str = newstr_arr.value(i);
let result = insert_string(original, pos, replace_len, new_str);
builder.append_value(&result);
}
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
}
}
/// Cast array to LargeUtf8 for uniform string access.
fn cast_to_large_utf8(array: &ArrayRef, name: &str) -> datafusion_common::Result<ArrayRef> {
cast(array.as_ref(), &DataType::LargeUtf8)
.map_err(|e| DataFusionError::Execution(format!("INSERT: {} cast failed: {}", name, e)))
}
fn cast_to_int64(array: &ArrayRef, name: &str) -> datafusion_common::Result<ArrayRef> {
cast(array.as_ref(), &DataType::Int64)
.map_err(|e| DataFusionError::Execution(format!("INSERT: {} cast failed: {}", name, e)))
}
/// Perform the INSERT string operation.
/// pos is 1-based. If pos < 1 or pos > len(str) + 1, returns original string.
fn insert_string(original: &str, pos: i64, replace_len: i64, new_str: &str) -> String {
let char_count = original.chars().count();
// MySQL behavior: if pos < 1 or pos > string length + 1, return original
if pos < 1 || pos as usize > char_count + 1 {
return original.to_string();
}
let start_idx = (pos - 1) as usize; // Convert to 0-based
// Calculate end index for replacement
let replace_len = if replace_len < 0 {
0
} else {
replace_len as usize
};
let end_idx = (start_idx + replace_len).min(char_count);
let start_byte = char_to_byte_idx(original, start_idx);
let end_byte = char_to_byte_idx(original, end_idx);
let mut result = String::with_capacity(original.len() + new_str.len());
result.push_str(&original[..start_byte]);
result.push_str(new_str);
result.push_str(&original[end_byte..]);
result
}
fn char_to_byte_idx(s: &str, char_idx: usize) -> usize {
s.char_indices()
.nth(char_idx)
.map(|(idx, _)| idx)
.unwrap_or(s.len())
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use datafusion_common::arrow::array::{Int64Array, StringArray};
use datafusion_common::arrow::datatypes::Field;
use datafusion_expr::ScalarFunctionArgs;
use super::*;
fn create_args(arrays: Vec<ArrayRef>) -> ScalarFunctionArgs {
let arg_fields: Vec<_> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
Arc::new(Field::new(
format!("arg_{}", i),
arr.data_type().clone(),
true,
))
})
.collect();
ScalarFunctionArgs {
args: arrays.iter().cloned().map(ColumnarValue::Array).collect(),
arg_fields,
return_field: Arc::new(Field::new("result", DataType::LargeUtf8, true)),
number_rows: arrays[0].len(),
config_options: Arc::new(datafusion_common::config::ConfigOptions::default()),
}
}
#[test]
fn test_insert_basic() {
let function = InsertFunction::default();
// INSERT('Quadratic', 3, 4, 'What') => 'QuWhattic'
let str_arr = Arc::new(StringArray::from(vec!["Quadratic"]));
let pos = Arc::new(Int64Array::from(vec![3]));
let len = Arc::new(Int64Array::from(vec![4]));
let newstr = Arc::new(StringArray::from(vec!["What"]));
let args = create_args(vec![str_arr, pos, len, newstr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "QuWhattic");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_insert_out_of_range_pos() {
let function = InsertFunction::default();
// INSERT('Quadratic', 0, 4, 'What') => 'Quadratic' (pos < 1)
let str_arr = Arc::new(StringArray::from(vec!["Quadratic", "Quadratic"]));
let pos = Arc::new(Int64Array::from(vec![0, 100]));
let len = Arc::new(Int64Array::from(vec![4, 4]));
let newstr = Arc::new(StringArray::from(vec!["What", "What"]));
let args = create_args(vec![str_arr, pos, len, newstr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "Quadratic"); // pos < 1
assert_eq!(str_array.value(1), "Quadratic"); // pos > length
} else {
panic!("Expected array result");
}
}
#[test]
fn test_insert_replace_to_end() {
let function = InsertFunction::default();
// INSERT('Quadratic', 3, 100, 'What') => 'QuWhat' (len exceeds remaining)
let str_arr = Arc::new(StringArray::from(vec!["Quadratic"]));
let pos = Arc::new(Int64Array::from(vec![3]));
let len = Arc::new(Int64Array::from(vec![100]));
let newstr = Arc::new(StringArray::from(vec!["What"]));
let args = create_args(vec![str_arr, pos, len, newstr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "QuWhat");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_insert_unicode() {
let function = InsertFunction::default();
// INSERT('hello世界', 6, 1, 'の') => 'helloの界'
let str_arr = Arc::new(StringArray::from(vec!["hello世界"]));
let pos = Arc::new(Int64Array::from(vec![6]));
let len = Arc::new(Int64Array::from(vec![1]));
let newstr = Arc::new(StringArray::from(vec![""]));
let args = create_args(vec![str_arr, pos, len, newstr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "helloの界");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_insert_with_nulls() {
let function = InsertFunction::default();
let str_arr = Arc::new(StringArray::from(vec![Some("hello"), None]));
let pos = Arc::new(Int64Array::from(vec![1, 1]));
let len = Arc::new(Int64Array::from(vec![1, 1]));
let newstr = Arc::new(StringArray::from(vec!["X", "X"]));
let args = create_args(vec![str_arr, pos, len, newstr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "Xello");
assert!(str_array.is_null(1));
} else {
panic!("Expected array result");
}
}
}

View File

@@ -1,373 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
//! MySQL-compatible LOCATE function implementation.
//!
//! LOCATE(substr, str) - Returns the position of the first occurrence of substr in str (1-based).
//! LOCATE(substr, str, pos) - Returns the position of the first occurrence of substr in str,
//! starting from position pos.
//! Returns 0 if substr is not found.
use std::fmt;
use std::sync::Arc;
use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{Array, ArrayRef, AsArray, Int64Builder};
use datafusion_common::arrow::compute::cast;
use datafusion_common::arrow::datatypes::DataType;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, TypeSignature, Volatility};
use crate::function::Function;
use crate::function_registry::FunctionRegistry;
const NAME: &str = "locate";
/// MySQL-compatible LOCATE function.
///
/// Syntax:
/// - LOCATE(substr, str) - Returns 1-based position of substr in str, or 0 if not found.
/// - LOCATE(substr, str, pos) - Same, but starts searching from position pos.
#[derive(Debug)]
pub struct LocateFunction {
signature: Signature,
}
impl LocateFunction {
pub fn register(registry: &FunctionRegistry) {
registry.register_scalar(LocateFunction::default());
}
}
impl Default for LocateFunction {
fn default() -> Self {
// Support 2 or 3 arguments with various string types
let mut signatures = Vec::new();
let string_types = [DataType::Utf8, DataType::LargeUtf8, DataType::Utf8View];
let int_types = [
DataType::Int64,
DataType::Int32,
DataType::Int16,
DataType::Int8,
DataType::UInt64,
DataType::UInt32,
DataType::UInt16,
DataType::UInt8,
];
// 2-argument form: LOCATE(substr, str)
for substr_type in &string_types {
for str_type in &string_types {
signatures.push(TypeSignature::Exact(vec![
substr_type.clone(),
str_type.clone(),
]));
}
}
// 3-argument form: LOCATE(substr, str, pos)
for substr_type in &string_types {
for str_type in &string_types {
for pos_type in &int_types {
signatures.push(TypeSignature::Exact(vec![
substr_type.clone(),
str_type.clone(),
pos_type.clone(),
]));
}
}
}
Self {
signature: Signature::one_of(signatures, Volatility::Immutable),
}
}
}
impl fmt::Display for LocateFunction {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", NAME.to_ascii_uppercase())
}
}
impl Function for LocateFunction {
fn name(&self) -> &str {
NAME
}
fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::Int64)
}
fn signature(&self) -> &Signature {
&self.signature
}
fn invoke_with_args(
&self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
let arg_count = args.args.len();
if !(2..=3).contains(&arg_count) {
return Err(DataFusionError::Execution(
"LOCATE requires 2 or 3 arguments: LOCATE(substr, str) or LOCATE(substr, str, pos)"
.to_string(),
));
}
let arrays = ColumnarValue::values_to_arrays(&args.args)?;
// Cast string arguments to LargeUtf8 for uniform access
let substr_array = cast_to_large_utf8(&arrays[0], "substr")?;
let str_array = cast_to_large_utf8(&arrays[1], "str")?;
let substr = substr_array.as_string::<i64>();
let str_arr = str_array.as_string::<i64>();
let len = substr.len();
// Handle optional pos argument
let pos_array: Option<ArrayRef> = if arg_count == 3 {
Some(cast_to_int64(&arrays[2], "pos")?)
} else {
None
};
let mut builder = Int64Builder::with_capacity(len);
for i in 0..len {
if substr.is_null(i) || str_arr.is_null(i) {
builder.append_null();
continue;
}
let needle = substr.value(i);
let haystack = str_arr.value(i);
// Get starting position (1-based in MySQL, convert to 0-based)
let start_pos = if let Some(ref pos_arr) = pos_array {
if pos_arr.is_null(i) {
builder.append_null();
continue;
}
let pos = pos_arr
.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>()
.value(i);
if pos < 1 {
// MySQL returns 0 for pos < 1
builder.append_value(0);
continue;
}
(pos - 1) as usize
} else {
0
};
// Find position using character-based indexing (for Unicode support)
let result = locate_substr(haystack, needle, start_pos);
builder.append_value(result);
}
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
}
}
/// Cast array to LargeUtf8 for uniform string access.
fn cast_to_large_utf8(array: &ArrayRef, name: &str) -> datafusion_common::Result<ArrayRef> {
cast(array.as_ref(), &DataType::LargeUtf8)
.map_err(|e| DataFusionError::Execution(format!("LOCATE: {} cast failed: {}", name, e)))
}
fn cast_to_int64(array: &ArrayRef, name: &str) -> datafusion_common::Result<ArrayRef> {
cast(array.as_ref(), &DataType::Int64)
.map_err(|e| DataFusionError::Execution(format!("LOCATE: {} cast failed: {}", name, e)))
}
/// Find the 1-based position of needle in haystack, starting from start_pos (0-based character index).
/// Returns 0 if not found.
fn locate_substr(haystack: &str, needle: &str, start_pos: usize) -> i64 {
// Handle empty needle - MySQL returns start_pos + 1
if needle.is_empty() {
let char_count = haystack.chars().count();
return if start_pos <= char_count {
(start_pos + 1) as i64
} else {
0
};
}
// Convert start_pos (character index) to byte index
let byte_start = haystack
.char_indices()
.nth(start_pos)
.map(|(idx, _)| idx)
.unwrap_or(haystack.len());
if byte_start >= haystack.len() {
return 0;
}
// Search in the substring
let search_str = &haystack[byte_start..];
if let Some(byte_pos) = search_str.find(needle) {
// Convert byte position back to character position
let char_pos = search_str[..byte_pos].chars().count();
// Return 1-based position relative to original string
(start_pos + char_pos + 1) as i64
} else {
0
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use datafusion_common::arrow::array::StringArray;
use datafusion_common::arrow::datatypes::Field;
use datafusion_expr::ScalarFunctionArgs;
use super::*;
fn create_args(arrays: Vec<ArrayRef>) -> ScalarFunctionArgs {
let arg_fields: Vec<_> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
Arc::new(Field::new(
format!("arg_{}", i),
arr.data_type().clone(),
true,
))
})
.collect();
ScalarFunctionArgs {
args: arrays.iter().cloned().map(ColumnarValue::Array).collect(),
arg_fields,
return_field: Arc::new(Field::new("result", DataType::Int64, true)),
number_rows: arrays[0].len(),
config_options: Arc::new(datafusion_common::config::ConfigOptions::default()),
}
}
#[test]
fn test_locate_basic() {
let function = LocateFunction::default();
let substr = Arc::new(StringArray::from(vec!["world", "xyz", "hello"]));
let str_arr = Arc::new(StringArray::from(vec![
"hello world",
"hello world",
"hello world",
]));
let args = create_args(vec![substr, str_arr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 7); // "world" at position 7
assert_eq!(int_array.value(1), 0); // "xyz" not found
assert_eq!(int_array.value(2), 1); // "hello" at position 1
} else {
panic!("Expected array result");
}
}
#[test]
fn test_locate_with_position() {
let function = LocateFunction::default();
let substr = Arc::new(StringArray::from(vec!["o", "o", "o"]));
let str_arr = Arc::new(StringArray::from(vec![
"hello world",
"hello world",
"hello world",
]));
let pos = Arc::new(datafusion_common::arrow::array::Int64Array::from(vec![
1, 5, 8,
]));
let args = create_args(vec![substr, str_arr, pos]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 5); // first 'o' at position 5
assert_eq!(int_array.value(1), 5); // 'o' at position 5 (start from 5)
assert_eq!(int_array.value(2), 8); // 'o' in "world" at position 8
} else {
panic!("Expected array result");
}
}
#[test]
fn test_locate_unicode() {
let function = LocateFunction::default();
let substr = Arc::new(StringArray::from(vec!["", ""]));
let str_arr = Arc::new(StringArray::from(vec!["hello世界", "hello世界"]));
let args = create_args(vec![substr, str_arr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 6); // "世" at position 6
assert_eq!(int_array.value(1), 7); // "界" at position 7
} else {
panic!("Expected array result");
}
}
#[test]
fn test_locate_empty_needle() {
let function = LocateFunction::default();
let substr = Arc::new(StringArray::from(vec!["", ""]));
let str_arr = Arc::new(StringArray::from(vec!["hello", "hello"]));
let pos = Arc::new(datafusion_common::arrow::array::Int64Array::from(vec![
1, 3,
]));
let args = create_args(vec![substr, str_arr, pos]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 1); // empty string at pos 1
assert_eq!(int_array.value(1), 3); // empty string at pos 3
} else {
panic!("Expected array result");
}
}
#[test]
fn test_locate_with_nulls() {
let function = LocateFunction::default();
let substr = Arc::new(StringArray::from(vec![Some("o"), None]));
let str_arr = Arc::new(StringArray::from(vec![Some("hello"), Some("hello")]));
let args = create_args(vec![substr, str_arr]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let int_array = array.as_primitive::<datafusion_common::arrow::datatypes::Int64Type>();
assert_eq!(int_array.value(0), 5);
assert!(int_array.is_null(1));
} else {
panic!("Expected array result");
}
}
}

View File

@@ -1,252 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
//! MySQL-compatible SPACE function implementation.
//!
//! SPACE(N) - Returns a string consisting of N space characters.
use std::fmt;
use std::sync::Arc;
use datafusion_common::DataFusionError;
use datafusion_common::arrow::array::{Array, AsArray, LargeStringBuilder};
use datafusion_common::arrow::datatypes::DataType;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs, Signature, TypeSignature, Volatility};
use crate::function::Function;
use crate::function_registry::FunctionRegistry;
const NAME: &str = "space";
// Safety limit for maximum number of spaces
const MAX_SPACE_COUNT: i64 = 1024 * 1024; // 1MB of spaces
/// MySQL-compatible SPACE function.
///
/// Syntax: SPACE(N)
/// Returns a string consisting of N space characters.
/// Returns NULL if N is NULL.
/// Returns empty string if N < 0.
#[derive(Debug)]
pub struct SpaceFunction {
signature: Signature,
}
impl SpaceFunction {
pub fn register(registry: &FunctionRegistry) {
registry.register_scalar(SpaceFunction::default());
}
}
impl Default for SpaceFunction {
fn default() -> Self {
Self {
signature: Signature::one_of(
vec![
TypeSignature::Exact(vec![DataType::Int64]),
TypeSignature::Exact(vec![DataType::Int32]),
TypeSignature::Exact(vec![DataType::Int16]),
TypeSignature::Exact(vec![DataType::Int8]),
TypeSignature::Exact(vec![DataType::UInt64]),
TypeSignature::Exact(vec![DataType::UInt32]),
TypeSignature::Exact(vec![DataType::UInt16]),
TypeSignature::Exact(vec![DataType::UInt8]),
],
Volatility::Immutable,
),
}
}
}
impl fmt::Display for SpaceFunction {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", NAME.to_ascii_uppercase())
}
}
impl Function for SpaceFunction {
fn name(&self) -> &str {
NAME
}
fn return_type(&self, _: &[DataType]) -> datafusion_common::Result<DataType> {
Ok(DataType::LargeUtf8)
}
fn signature(&self) -> &Signature {
&self.signature
}
fn invoke_with_args(
&self,
args: ScalarFunctionArgs,
) -> datafusion_common::Result<ColumnarValue> {
if args.args.len() != 1 {
return Err(DataFusionError::Execution(
"SPACE requires exactly 1 argument: SPACE(N)".to_string(),
));
}
let arrays = ColumnarValue::values_to_arrays(&args.args)?;
let len = arrays[0].len();
let n_array = &arrays[0];
let mut builder = LargeStringBuilder::with_capacity(len, len * 10);
for i in 0..len {
if n_array.is_null(i) {
builder.append_null();
continue;
}
let n = get_int_value(n_array, i)?;
if n < 0 {
// MySQL returns empty string for negative values
builder.append_value("");
} else if n > MAX_SPACE_COUNT {
return Err(DataFusionError::Execution(format!(
"SPACE: requested {} spaces exceeds maximum allowed ({})",
n, MAX_SPACE_COUNT
)));
} else {
let spaces = " ".repeat(n as usize);
builder.append_value(&spaces);
}
}
Ok(ColumnarValue::Array(Arc::new(builder.finish())))
}
}
/// Extract integer value from various integer types.
fn get_int_value(
array: &datafusion_common::arrow::array::ArrayRef,
index: usize,
) -> datafusion_common::Result<i64> {
use datafusion_common::arrow::datatypes as arrow_types;
match array.data_type() {
DataType::Int64 => Ok(array.as_primitive::<arrow_types::Int64Type>().value(index)),
DataType::Int32 => Ok(array.as_primitive::<arrow_types::Int32Type>().value(index) as i64),
DataType::Int16 => Ok(array.as_primitive::<arrow_types::Int16Type>().value(index) as i64),
DataType::Int8 => Ok(array.as_primitive::<arrow_types::Int8Type>().value(index) as i64),
DataType::UInt64 => {
let v = array.as_primitive::<arrow_types::UInt64Type>().value(index);
if v > i64::MAX as u64 {
Err(DataFusionError::Execution(format!(
"SPACE: value {} exceeds maximum",
v
)))
} else {
Ok(v as i64)
}
}
DataType::UInt32 => Ok(array.as_primitive::<arrow_types::UInt32Type>().value(index) as i64),
DataType::UInt16 => Ok(array.as_primitive::<arrow_types::UInt16Type>().value(index) as i64),
DataType::UInt8 => Ok(array.as_primitive::<arrow_types::UInt8Type>().value(index) as i64),
_ => Err(DataFusionError::Execution(format!(
"SPACE: unsupported type {:?}",
array.data_type()
))),
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use datafusion_common::arrow::array::Int64Array;
use datafusion_common::arrow::datatypes::Field;
use datafusion_expr::ScalarFunctionArgs;
use super::*;
fn create_args(arrays: Vec<datafusion_common::arrow::array::ArrayRef>) -> ScalarFunctionArgs {
let arg_fields: Vec<_> = arrays
.iter()
.enumerate()
.map(|(i, arr)| {
Arc::new(Field::new(
format!("arg_{}", i),
arr.data_type().clone(),
true,
))
})
.collect();
ScalarFunctionArgs {
args: arrays.iter().cloned().map(ColumnarValue::Array).collect(),
arg_fields,
return_field: Arc::new(Field::new("result", DataType::LargeUtf8, true)),
number_rows: arrays[0].len(),
config_options: Arc::new(datafusion_common::config::ConfigOptions::default()),
}
}
#[test]
fn test_space_basic() {
let function = SpaceFunction::default();
let n = Arc::new(Int64Array::from(vec![0, 1, 5]));
let args = create_args(vec![n]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "");
assert_eq!(str_array.value(1), " ");
assert_eq!(str_array.value(2), " ");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_space_negative() {
let function = SpaceFunction::default();
let n = Arc::new(Int64Array::from(vec![-1, -100]));
let args = create_args(vec![n]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), "");
assert_eq!(str_array.value(1), "");
} else {
panic!("Expected array result");
}
}
#[test]
fn test_space_with_nulls() {
let function = SpaceFunction::default();
let n = Arc::new(Int64Array::from(vec![Some(3), None]));
let args = create_args(vec![n]);
let result = function.invoke_with_args(args).unwrap();
if let ColumnarValue::Array(array) = result {
let str_array = array.as_string::<i64>();
assert_eq!(str_array.value(0), " ");
assert!(str_array.is_null(1));
} else {
panic!("Expected array result");
}
}
}

View File

@@ -13,7 +13,6 @@
// limitations under the License. // limitations under the License.
use std::any::Any; use std::any::Any;
use std::time::Duration;
use common_error::ext::ErrorExt; use common_error::ext::ErrorExt;
use common_error::status_code::StatusCode; use common_error::status_code::StatusCode;
@@ -36,14 +35,6 @@ pub enum Error {
#[snafu(display("Memory semaphore unexpectedly closed"))] #[snafu(display("Memory semaphore unexpectedly closed"))]
MemorySemaphoreClosed, MemorySemaphoreClosed,
#[snafu(display(
"Timeout waiting for memory quota: requested {requested_bytes} bytes, waited {waited:?}"
))]
MemoryAcquireTimeout {
requested_bytes: u64,
waited: Duration,
},
} }
impl ErrorExt for Error { impl ErrorExt for Error {
@@ -53,7 +44,6 @@ impl ErrorExt for Error {
match self { match self {
MemoryLimitExceeded { .. } => StatusCode::RuntimeResourcesExhausted, MemoryLimitExceeded { .. } => StatusCode::RuntimeResourcesExhausted,
MemorySemaphoreClosed => StatusCode::Unexpected, MemorySemaphoreClosed => StatusCode::Unexpected,
MemoryAcquireTimeout { .. } => StatusCode::RuntimeResourcesExhausted,
} }
} }

View File

@@ -1,168 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
use std::fmt;
/// Memory permit granularity for different use cases.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum PermitGranularity {
/// 1 KB per permit
///
/// Use for:
/// - HTTP/gRPC request limiting (small, high-concurrency operations)
/// - Small batch operations
/// - Scenarios requiring fine-grained fairness
Kilobyte,
/// 1 MB per permit (default)
///
/// Use for:
/// - Query execution memory management
/// - Compaction memory control
/// - Large, long-running operations
#[default]
Megabyte,
}
impl PermitGranularity {
/// Returns the number of bytes per permit.
#[inline]
pub const fn bytes(self) -> u64 {
match self {
Self::Kilobyte => 1024,
Self::Megabyte => 1024 * 1024,
}
}
/// Returns a human-readable string representation.
pub const fn as_str(self) -> &'static str {
match self {
Self::Kilobyte => "1KB",
Self::Megabyte => "1MB",
}
}
/// Converts bytes to permits based on this granularity.
///
/// Rounds up to ensure the requested bytes are fully covered.
/// Clamped to Semaphore::MAX_PERMITS.
#[inline]
pub fn bytes_to_permits(self, bytes: u64) -> u32 {
use tokio::sync::Semaphore;
let granularity_bytes = self.bytes();
bytes
.saturating_add(granularity_bytes - 1)
.saturating_div(granularity_bytes)
.min(Semaphore::MAX_PERMITS as u64)
.min(u32::MAX as u64) as u32
}
/// Converts permits to bytes based on this granularity.
#[inline]
pub fn permits_to_bytes(self, permits: u32) -> u64 {
(permits as u64).saturating_mul(self.bytes())
}
}
impl fmt::Display for PermitGranularity {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.as_str())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_bytes_to_permits_kilobyte() {
let granularity = PermitGranularity::Kilobyte;
// Exact multiples
assert_eq!(granularity.bytes_to_permits(1024), 1);
assert_eq!(granularity.bytes_to_permits(2048), 2);
assert_eq!(granularity.bytes_to_permits(10 * 1024), 10);
// Rounds up
assert_eq!(granularity.bytes_to_permits(1), 1);
assert_eq!(granularity.bytes_to_permits(1025), 2);
assert_eq!(granularity.bytes_to_permits(2047), 2);
}
#[test]
fn test_bytes_to_permits_megabyte() {
let granularity = PermitGranularity::Megabyte;
// Exact multiples
assert_eq!(granularity.bytes_to_permits(1024 * 1024), 1);
assert_eq!(granularity.bytes_to_permits(2 * 1024 * 1024), 2);
// Rounds up
assert_eq!(granularity.bytes_to_permits(1), 1);
assert_eq!(granularity.bytes_to_permits(1024), 1);
assert_eq!(granularity.bytes_to_permits(1024 * 1024 + 1), 2);
}
#[test]
fn test_bytes_to_permits_zero_bytes() {
assert_eq!(PermitGranularity::Kilobyte.bytes_to_permits(0), 0);
assert_eq!(PermitGranularity::Megabyte.bytes_to_permits(0), 0);
}
#[test]
fn test_bytes_to_permits_clamps_to_maximum() {
use tokio::sync::Semaphore;
let max_permits = (Semaphore::MAX_PERMITS as u64).min(u32::MAX as u64) as u32;
assert_eq!(
PermitGranularity::Kilobyte.bytes_to_permits(u64::MAX),
max_permits
);
assert_eq!(
PermitGranularity::Megabyte.bytes_to_permits(u64::MAX),
max_permits
);
}
#[test]
fn test_permits_to_bytes() {
assert_eq!(PermitGranularity::Kilobyte.permits_to_bytes(1), 1024);
assert_eq!(PermitGranularity::Kilobyte.permits_to_bytes(10), 10 * 1024);
assert_eq!(PermitGranularity::Megabyte.permits_to_bytes(1), 1024 * 1024);
assert_eq!(
PermitGranularity::Megabyte.permits_to_bytes(10),
10 * 1024 * 1024
);
}
#[test]
fn test_round_trip_conversion() {
// Kilobyte: bytes -> permits -> bytes (should round up)
let kb = PermitGranularity::Kilobyte;
let permits = kb.bytes_to_permits(1500);
let bytes = kb.permits_to_bytes(permits);
assert!(bytes >= 1500); // Must cover original request
assert_eq!(bytes, 2048); // 2KB
// Megabyte: bytes -> permits -> bytes (should round up)
let mb = PermitGranularity::Megabyte;
let permits = mb.bytes_to_permits(1500);
let bytes = mb.permits_to_bytes(permits);
assert!(bytes >= 1500);
assert_eq!(bytes, 1024 * 1024); // 1MB
}
}

View File

@@ -15,14 +15,9 @@
use std::{fmt, mem}; use std::{fmt, mem};
use common_telemetry::debug; use common_telemetry::debug;
use snafu::ensure;
use tokio::sync::{OwnedSemaphorePermit, TryAcquireError}; use tokio::sync::{OwnedSemaphorePermit, TryAcquireError};
use crate::error::{ use crate::manager::{MemoryMetrics, MemoryQuota, bytes_to_permits, permits_to_bytes};
MemoryAcquireTimeoutSnafu, MemoryLimitExceededSnafu, MemorySemaphoreClosedSnafu, Result,
};
use crate::manager::{MemoryMetrics, MemoryQuota};
use crate::policy::OnExhaustedPolicy;
/// Guard representing a slice of reserved memory. /// Guard representing a slice of reserved memory.
pub struct MemoryGuard<M: MemoryMetrics> { pub struct MemoryGuard<M: MemoryMetrics> {
@@ -54,58 +49,15 @@ impl<M: MemoryMetrics> MemoryGuard<M> {
pub fn granted_bytes(&self) -> u64 { pub fn granted_bytes(&self) -> u64 {
match &self.state { match &self.state {
GuardState::Unlimited => 0, GuardState::Unlimited => 0,
GuardState::Limited { permit, quota } => { GuardState::Limited { permit, .. } => permits_to_bytes(permit.num_permits() as u32),
quota.permits_to_bytes(permit.num_permits() as u32)
}
} }
} }
/// Acquires additional memory, waiting if necessary until enough is available. /// Tries to allocate additional memory during task execution.
///
/// On success, merges the new memory into this guard.
///
/// # Errors
/// - Returns error if requested bytes would exceed the manager's total limit
/// - Returns error if the semaphore is unexpectedly closed
pub async fn acquire_additional(&mut self, bytes: u64) -> Result<()> {
match &mut self.state {
GuardState::Unlimited => Ok(()),
GuardState::Limited { permit, quota } => {
if bytes == 0 {
return Ok(());
}
let additional_permits = quota.bytes_to_permits(bytes);
let current_permits = permit.num_permits() as u32;
ensure!(
current_permits.saturating_add(additional_permits) <= quota.limit_permits,
MemoryLimitExceededSnafu {
requested_bytes: bytes,
limit_bytes: quota.permits_to_bytes(quota.limit_permits)
}
);
let additional_permit = quota
.semaphore
.clone()
.acquire_many_owned(additional_permits)
.await
.map_err(|_| MemorySemaphoreClosedSnafu.build())?;
permit.merge(additional_permit);
quota.update_in_use_metric();
debug!("Acquired additional {} bytes", bytes);
Ok(())
}
}
}
/// Tries to acquire additional memory without waiting.
/// ///
/// On success, merges the new memory into this guard and returns true. /// On success, merges the new memory into this guard and returns true.
/// On failure, returns false and leaves this guard unchanged. /// On failure, returns false and leaves this guard unchanged.
pub fn try_acquire_additional(&mut self, bytes: u64) -> bool { pub fn request_additional(&mut self, bytes: u64) -> bool {
match &mut self.state { match &mut self.state {
GuardState::Unlimited => true, GuardState::Unlimited => true,
GuardState::Limited { permit, quota } => { GuardState::Limited { permit, quota } => {
@@ -113,7 +65,7 @@ impl<M: MemoryMetrics> MemoryGuard<M> {
return true; return true;
} }
let additional_permits = quota.bytes_to_permits(bytes); let additional_permits = bytes_to_permits(bytes);
match quota match quota
.semaphore .semaphore
@@ -123,11 +75,11 @@ impl<M: MemoryMetrics> MemoryGuard<M> {
Ok(additional_permit) => { Ok(additional_permit) => {
permit.merge(additional_permit); permit.merge(additional_permit);
quota.update_in_use_metric(); quota.update_in_use_metric();
debug!("Acquired additional {} bytes", bytes); debug!("Allocated additional {} bytes", bytes);
true true
} }
Err(TryAcquireError::NoPermits) | Err(TryAcquireError::Closed) => { Err(TryAcquireError::NoPermits) | Err(TryAcquireError::Closed) => {
quota.metrics.inc_rejected("try_acquire_additional"); quota.metrics.inc_rejected("request_additional");
false false
} }
} }
@@ -135,55 +87,11 @@ impl<M: MemoryMetrics> MemoryGuard<M> {
} }
} }
/// Acquires additional memory based on the given policy. /// Releases a portion of granted memory back to the pool early,
/// /// before the guard is dropped.
/// - For `OnExhaustedPolicy::Wait`: Waits up to the timeout duration for memory to become available
/// - For `OnExhaustedPolicy::Fail`: Returns immediately if memory is not available
///
/// # Errors
/// - `MemoryLimitExceeded`: Requested bytes would exceed the total limit (both policies), or memory is currently exhausted (Fail policy only)
/// - `MemoryAcquireTimeout`: Timeout elapsed while waiting for memory (Wait policy only)
/// - `MemorySemaphoreClosed`: The internal semaphore is unexpectedly closed (rare, indicates system issue)
pub async fn acquire_additional_with_policy(
&mut self,
bytes: u64,
policy: OnExhaustedPolicy,
) -> Result<()> {
match policy {
OnExhaustedPolicy::Wait { timeout } => {
match tokio::time::timeout(timeout, self.acquire_additional(bytes)).await {
Ok(Ok(())) => Ok(()),
Ok(Err(e)) => Err(e),
Err(_elapsed) => MemoryAcquireTimeoutSnafu {
requested_bytes: bytes,
waited: timeout,
}
.fail(),
}
}
OnExhaustedPolicy::Fail => {
if self.try_acquire_additional(bytes) {
Ok(())
} else {
MemoryLimitExceededSnafu {
requested_bytes: bytes,
limit_bytes: match &self.state {
GuardState::Unlimited => 0, // unreachable: unlimited mode always succeeds
GuardState::Limited { quota, .. } => {
quota.permits_to_bytes(quota.limit_permits)
}
},
}
.fail()
}
}
}
}
/// Releases a portion of granted memory back to the pool before the guard is dropped.
/// ///
/// Returns true if the release succeeds or is a no-op; false if the request exceeds granted. /// Returns true if the release succeeds or is a no-op; false if the request exceeds granted.
pub fn release_partial(&mut self, bytes: u64) -> bool { pub fn early_release_partial(&mut self, bytes: u64) -> bool {
match &mut self.state { match &mut self.state {
GuardState::Unlimited => true, GuardState::Unlimited => true,
GuardState::Limited { permit, quota } => { GuardState::Limited { permit, quota } => {
@@ -191,15 +99,14 @@ impl<M: MemoryMetrics> MemoryGuard<M> {
return true; return true;
} }
let release_permits = quota.bytes_to_permits(bytes); let release_permits = bytes_to_permits(bytes);
match permit.split(release_permits as usize) { match permit.split(release_permits as usize) {
Some(released_permit) => { Some(released_permit) => {
let released_bytes = let released_bytes = permits_to_bytes(released_permit.num_permits() as u32);
quota.permits_to_bytes(released_permit.num_permits() as u32);
drop(released_permit); drop(released_permit);
quota.update_in_use_metric(); quota.update_in_use_metric();
debug!("Released {} bytes from memory guard", released_bytes); debug!("Early released {} bytes from memory guard", released_bytes);
true true
} }
None => false, None => false,
@@ -214,7 +121,7 @@ impl<M: MemoryMetrics> Drop for MemoryGuard<M> {
if let GuardState::Limited { permit, quota } = if let GuardState::Limited { permit, quota } =
mem::replace(&mut self.state, GuardState::Unlimited) mem::replace(&mut self.state, GuardState::Unlimited)
{ {
let bytes = quota.permits_to_bytes(permit.num_permits() as u32); let bytes = permits_to_bytes(permit.num_permits() as u32);
drop(permit); drop(permit);
quota.update_in_use_metric(); quota.update_in_use_metric();
debug!("Released memory: {} bytes", bytes); debug!("Released memory: {} bytes", bytes);

View File

@@ -19,7 +19,6 @@
//! share the same allocation logic while using their own metrics. //! share the same allocation logic while using their own metrics.
mod error; mod error;
mod granularity;
mod guard; mod guard;
mod manager; mod manager;
mod policy; mod policy;
@@ -28,9 +27,8 @@ mod policy;
mod tests; mod tests;
pub use error::{Error, Result}; pub use error::{Error, Result};
pub use granularity::PermitGranularity;
pub use guard::MemoryGuard; pub use guard::MemoryGuard;
pub use manager::{MemoryManager, MemoryMetrics}; pub use manager::{MemoryManager, MemoryMetrics, PERMIT_GRANULARITY_BYTES};
pub use policy::{DEFAULT_MEMORY_WAIT_TIMEOUT, OnExhaustedPolicy}; pub use policy::{DEFAULT_MEMORY_WAIT_TIMEOUT, OnExhaustedPolicy};
/// No-op metrics implementation for testing. /// No-op metrics implementation for testing.

View File

@@ -17,12 +17,11 @@ use std::sync::Arc;
use snafu::ensure; use snafu::ensure;
use tokio::sync::{Semaphore, TryAcquireError}; use tokio::sync::{Semaphore, TryAcquireError};
use crate::error::{ use crate::error::{MemoryLimitExceededSnafu, MemorySemaphoreClosedSnafu, Result};
MemoryAcquireTimeoutSnafu, MemoryLimitExceededSnafu, MemorySemaphoreClosedSnafu, Result,
};
use crate::granularity::PermitGranularity;
use crate::guard::MemoryGuard; use crate::guard::MemoryGuard;
use crate::policy::OnExhaustedPolicy;
/// Minimum bytes controlled by one semaphore permit.
pub const PERMIT_GRANULARITY_BYTES: u64 = 1 << 20; // 1 MB
/// Trait for recording memory usage metrics. /// Trait for recording memory usage metrics.
pub trait MemoryMetrics: Clone + Send + Sync + 'static { pub trait MemoryMetrics: Clone + Send + Sync + 'static {
@@ -37,17 +36,10 @@ pub struct MemoryManager<M: MemoryMetrics> {
quota: Option<MemoryQuota<M>>, quota: Option<MemoryQuota<M>>,
} }
impl<M: MemoryMetrics + Default> Default for MemoryManager<M> {
fn default() -> Self {
Self::new(0, M::default())
}
}
#[derive(Clone)] #[derive(Clone)]
pub(crate) struct MemoryQuota<M: MemoryMetrics> { pub(crate) struct MemoryQuota<M: MemoryMetrics> {
pub(crate) semaphore: Arc<Semaphore>, pub(crate) semaphore: Arc<Semaphore>,
pub(crate) limit_permits: u32, pub(crate) limit_permits: u32,
pub(crate) granularity: PermitGranularity,
pub(crate) metrics: M, pub(crate) metrics: M,
} }
@@ -55,25 +47,19 @@ impl<M: MemoryMetrics> MemoryManager<M> {
/// Creates a new memory manager with the given limit in bytes. /// Creates a new memory manager with the given limit in bytes.
/// `limit_bytes = 0` disables the limit. /// `limit_bytes = 0` disables the limit.
pub fn new(limit_bytes: u64, metrics: M) -> Self { pub fn new(limit_bytes: u64, metrics: M) -> Self {
Self::with_granularity(limit_bytes, PermitGranularity::default(), metrics)
}
/// Creates a new memory manager with specified granularity.
pub fn with_granularity(limit_bytes: u64, granularity: PermitGranularity, metrics: M) -> Self {
if limit_bytes == 0 { if limit_bytes == 0 {
metrics.set_limit(0); metrics.set_limit(0);
return Self { quota: None }; return Self { quota: None };
} }
let limit_permits = granularity.bytes_to_permits(limit_bytes); let limit_permits = bytes_to_permits(limit_bytes);
let limit_aligned_bytes = granularity.permits_to_bytes(limit_permits); let limit_aligned_bytes = permits_to_bytes(limit_permits);
metrics.set_limit(limit_aligned_bytes as i64); metrics.set_limit(limit_aligned_bytes as i64);
Self { Self {
quota: Some(MemoryQuota { quota: Some(MemoryQuota {
semaphore: Arc::new(Semaphore::new(limit_permits as usize)), semaphore: Arc::new(Semaphore::new(limit_permits as usize)),
limit_permits, limit_permits,
granularity,
metrics, metrics,
}), }),
} }
@@ -83,7 +69,7 @@ impl<M: MemoryMetrics> MemoryManager<M> {
pub fn limit_bytes(&self) -> u64 { pub fn limit_bytes(&self) -> u64 {
self.quota self.quota
.as_ref() .as_ref()
.map(|quota| quota.permits_to_bytes(quota.limit_permits)) .map(|quota| permits_to_bytes(quota.limit_permits))
.unwrap_or(0) .unwrap_or(0)
} }
@@ -91,7 +77,7 @@ impl<M: MemoryMetrics> MemoryManager<M> {
pub fn used_bytes(&self) -> u64 { pub fn used_bytes(&self) -> u64 {
self.quota self.quota
.as_ref() .as_ref()
.map(|quota| quota.permits_to_bytes(quota.used_permits())) .map(|quota| permits_to_bytes(quota.used_permits()))
.unwrap_or(0) .unwrap_or(0)
} }
@@ -99,7 +85,7 @@ impl<M: MemoryMetrics> MemoryManager<M> {
pub fn available_bytes(&self) -> u64 { pub fn available_bytes(&self) -> u64 {
self.quota self.quota
.as_ref() .as_ref()
.map(|quota| quota.permits_to_bytes(quota.available_permits_clamped())) .map(|quota| permits_to_bytes(quota.available_permits_clamped()))
.unwrap_or(0) .unwrap_or(0)
} }
@@ -112,13 +98,13 @@ impl<M: MemoryMetrics> MemoryManager<M> {
match &self.quota { match &self.quota {
None => Ok(MemoryGuard::unlimited()), None => Ok(MemoryGuard::unlimited()),
Some(quota) => { Some(quota) => {
let permits = quota.bytes_to_permits(bytes); let permits = bytes_to_permits(bytes);
ensure!( ensure!(
permits <= quota.limit_permits, permits <= quota.limit_permits,
MemoryLimitExceededSnafu { MemoryLimitExceededSnafu {
requested_bytes: bytes, requested_bytes: bytes,
limit_bytes: self.limit_bytes() limit_bytes: permits_to_bytes(quota.limit_permits),
} }
); );
@@ -139,7 +125,7 @@ impl<M: MemoryMetrics> MemoryManager<M> {
match &self.quota { match &self.quota {
None => Some(MemoryGuard::unlimited()), None => Some(MemoryGuard::unlimited()),
Some(quota) => { Some(quota) => {
let permits = quota.bytes_to_permits(bytes); let permits = bytes_to_permits(bytes);
match quota.semaphore.clone().try_acquire_many_owned(permits) { match quota.semaphore.clone().try_acquire_many_owned(permits) {
Ok(permit) => { Ok(permit) => {
@@ -154,56 +140,9 @@ impl<M: MemoryMetrics> MemoryManager<M> {
} }
} }
} }
/// Acquires memory based on the given policy.
///
/// - For `OnExhaustedPolicy::Wait`: Waits up to the timeout duration for memory to become available
/// - For `OnExhaustedPolicy::Fail`: Returns immediately if memory is not available
///
/// # Errors
/// - `MemoryLimitExceeded`: Requested bytes exceed the total limit (both policies), or memory is currently exhausted (Fail policy only)
/// - `MemoryAcquireTimeout`: Timeout elapsed while waiting for memory (Wait policy only)
/// - `MemorySemaphoreClosed`: The internal semaphore is unexpectedly closed (rare, indicates system issue)
pub async fn acquire_with_policy(
&self,
bytes: u64,
policy: OnExhaustedPolicy,
) -> Result<MemoryGuard<M>> {
match policy {
OnExhaustedPolicy::Wait { timeout } => {
match tokio::time::timeout(timeout, self.acquire(bytes)).await {
Ok(Ok(guard)) => Ok(guard),
Ok(Err(e)) => Err(e),
Err(_elapsed) => {
// Timeout elapsed while waiting
MemoryAcquireTimeoutSnafu {
requested_bytes: bytes,
waited: timeout,
}
.fail()
}
}
}
OnExhaustedPolicy::Fail => self.try_acquire(bytes).ok_or_else(|| {
MemoryLimitExceededSnafu {
requested_bytes: bytes,
limit_bytes: self.limit_bytes(),
}
.build()
}),
}
}
} }
impl<M: MemoryMetrics> MemoryQuota<M> { impl<M: MemoryMetrics> MemoryQuota<M> {
pub(crate) fn bytes_to_permits(&self, bytes: u64) -> u32 {
self.granularity.bytes_to_permits(bytes)
}
pub(crate) fn permits_to_bytes(&self, permits: u32) -> u64 {
self.granularity.permits_to_bytes(permits)
}
pub(crate) fn used_permits(&self) -> u32 { pub(crate) fn used_permits(&self) -> u32 {
self.limit_permits self.limit_permits
.saturating_sub(self.available_permits_clamped()) .saturating_sub(self.available_permits_clamped())
@@ -216,7 +155,19 @@ impl<M: MemoryMetrics> MemoryQuota<M> {
} }
pub(crate) fn update_in_use_metric(&self) { pub(crate) fn update_in_use_metric(&self) {
let bytes = self.permits_to_bytes(self.used_permits()); let bytes = permits_to_bytes(self.used_permits());
self.metrics.set_in_use(bytes as i64); self.metrics.set_in_use(bytes as i64);
} }
} }
pub(crate) fn bytes_to_permits(bytes: u64) -> u32 {
bytes
.saturating_add(PERMIT_GRANULARITY_BYTES - 1)
.saturating_div(PERMIT_GRANULARITY_BYTES)
.min(Semaphore::MAX_PERMITS as u64)
.min(u32::MAX as u64) as u32
}
pub(crate) fn permits_to_bytes(permits: u32) -> u64 {
(permits as u64).saturating_mul(PERMIT_GRANULARITY_BYTES)
}

View File

@@ -14,10 +14,7 @@
use tokio::time::{Duration, sleep}; use tokio::time::{Duration, sleep};
use crate::{MemoryManager, NoOpMetrics, PermitGranularity}; use crate::{MemoryManager, NoOpMetrics, PERMIT_GRANULARITY_BYTES};
// Helper constant for tests - use default Megabyte granularity
const PERMIT_GRANULARITY_BYTES: u64 = PermitGranularity::Megabyte.bytes();
#[test] #[test]
fn test_try_acquire_unlimited() { fn test_try_acquire_unlimited() {
@@ -83,7 +80,7 @@ fn test_request_additional_success() {
assert_eq!(manager.used_bytes(), base); assert_eq!(manager.used_bytes(), base);
// Request additional memory (3MB) - should succeed and merge // Request additional memory (3MB) - should succeed and merge
assert!(guard.try_acquire_additional(3 * PERMIT_GRANULARITY_BYTES)); assert!(guard.request_additional(3 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 8 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
} }
@@ -98,11 +95,11 @@ fn test_request_additional_exceeds_limit() {
let mut guard = manager.try_acquire(base).unwrap(); let mut guard = manager.try_acquire(base).unwrap();
// Request additional memory (3MB) - should succeed // Request additional memory (3MB) - should succeed
assert!(guard.try_acquire_additional(3 * PERMIT_GRANULARITY_BYTES)); assert!(guard.request_additional(3 * PERMIT_GRANULARITY_BYTES));
assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
// Request more (3MB) - should fail (would exceed 10MB limit) // Request more (3MB) - should fail (would exceed 10MB limit)
let result = guard.try_acquire_additional(3 * PERMIT_GRANULARITY_BYTES); let result = guard.request_additional(3 * PERMIT_GRANULARITY_BYTES);
assert!(!result); assert!(!result);
// Still at 8MB // Still at 8MB
@@ -119,7 +116,7 @@ fn test_request_additional_auto_release_on_guard_drop() {
let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap(); let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap();
// Request additional - memory is merged into guard // Request additional - memory is merged into guard
assert!(guard.try_acquire_additional(3 * PERMIT_GRANULARITY_BYTES)); assert!(guard.request_additional(3 * PERMIT_GRANULARITY_BYTES));
assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
// When guard drops, all memory (base + additional) is released together // When guard drops, all memory (base + additional) is released together
@@ -135,7 +132,7 @@ fn test_request_additional_unlimited() {
let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap(); let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap();
// Should always succeed with unlimited manager // Should always succeed with unlimited manager
assert!(guard.try_acquire_additional(100 * PERMIT_GRANULARITY_BYTES)); assert!(guard.request_additional(100 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 0); assert_eq!(guard.granted_bytes(), 0);
assert_eq!(manager.used_bytes(), 0); assert_eq!(manager.used_bytes(), 0);
} }
@@ -148,7 +145,7 @@ fn test_request_additional_zero_bytes() {
let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap(); let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap();
// Request 0 bytes should succeed without affecting anything // Request 0 bytes should succeed without affecting anything
assert!(guard.try_acquire_additional(0)); assert!(guard.request_additional(0));
assert_eq!(guard.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 5 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
} }
@@ -162,7 +159,7 @@ fn test_early_release_partial_success() {
assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
// Release half // Release half
assert!(guard.release_partial(4 * PERMIT_GRANULARITY_BYTES)); assert!(guard.early_release_partial(4 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 4 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 4 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 4 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 4 * PERMIT_GRANULARITY_BYTES);
@@ -177,7 +174,7 @@ fn test_early_release_partial_exceeds_granted() {
let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap(); let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap();
// Try to release more than granted - should fail // Try to release more than granted - should fail
assert!(!guard.release_partial(10 * PERMIT_GRANULARITY_BYTES)); assert!(!guard.early_release_partial(10 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 5 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
} }
@@ -188,7 +185,7 @@ fn test_early_release_partial_unlimited() {
let mut guard = manager.try_acquire(100 * PERMIT_GRANULARITY_BYTES).unwrap(); let mut guard = manager.try_acquire(100 * PERMIT_GRANULARITY_BYTES).unwrap();
// Unlimited guard - release should succeed (no-op) // Unlimited guard - release should succeed (no-op)
assert!(guard.release_partial(50 * PERMIT_GRANULARITY_BYTES)); assert!(guard.early_release_partial(50 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 0); assert_eq!(guard.granted_bytes(), 0);
} }
@@ -200,22 +197,22 @@ fn test_request_and_early_release_symmetry() {
let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap(); let mut guard = manager.try_acquire(5 * PERMIT_GRANULARITY_BYTES).unwrap();
// Request additional // Request additional
assert!(guard.try_acquire_additional(5 * PERMIT_GRANULARITY_BYTES)); assert!(guard.request_additional(5 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 10 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 10 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 10 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 10 * PERMIT_GRANULARITY_BYTES);
// Early release some // Early release some
assert!(guard.release_partial(3 * PERMIT_GRANULARITY_BYTES)); assert!(guard.early_release_partial(3 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 7 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 7 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 7 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 7 * PERMIT_GRANULARITY_BYTES);
// Request again // Request again
assert!(guard.try_acquire_additional(2 * PERMIT_GRANULARITY_BYTES)); assert!(guard.request_additional(2 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 9 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 9 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 9 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 9 * PERMIT_GRANULARITY_BYTES);
// Early release again // Early release again
assert!(guard.release_partial(4 * PERMIT_GRANULARITY_BYTES)); assert!(guard.early_release_partial(4 * PERMIT_GRANULARITY_BYTES));
assert_eq!(guard.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 5 * PERMIT_GRANULARITY_BYTES); assert_eq!(manager.used_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
@@ -226,186 +223,25 @@ fn test_request_and_early_release_symmetry() {
#[test] #[test]
fn test_small_allocation_rounds_up() { fn test_small_allocation_rounds_up() {
// Test that allocations smaller than PERMIT_GRANULARITY_BYTES // Test that allocations smaller than PERMIT_GRANULARITY_BYTES
// round up to 1 permit and can use try_acquire_additional() // round up to 1 permit and can use request_additional()
let limit = 10 * PERMIT_GRANULARITY_BYTES; let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics); let manager = MemoryManager::new(limit, NoOpMetrics);
let mut guard = manager.try_acquire(512 * 1024).unwrap(); // 512KB let mut guard = manager.try_acquire(512 * 1024).unwrap(); // 512KB
assert_eq!(guard.granted_bytes(), PERMIT_GRANULARITY_BYTES); // Rounds up to 1MB assert_eq!(guard.granted_bytes(), PERMIT_GRANULARITY_BYTES); // Rounds up to 1MB
assert!(guard.try_acquire_additional(2 * PERMIT_GRANULARITY_BYTES)); // Can request more assert!(guard.request_additional(2 * PERMIT_GRANULARITY_BYTES)); // Can request more
assert_eq!(guard.granted_bytes(), 3 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 3 * PERMIT_GRANULARITY_BYTES);
} }
#[test] #[test]
fn test_acquire_zero_bytes_lazy_allocation() { fn test_acquire_zero_bytes_lazy_allocation() {
// Test that acquire(0) returns 0 permits but can try_acquire_additional() later // Test that acquire(0) returns 0 permits but can request_additional() later
let manager = MemoryManager::new(10 * PERMIT_GRANULARITY_BYTES, NoOpMetrics); let manager = MemoryManager::new(10 * PERMIT_GRANULARITY_BYTES, NoOpMetrics);
let mut guard = manager.try_acquire(0).unwrap(); let mut guard = manager.try_acquire(0).unwrap();
assert_eq!(guard.granted_bytes(), 0); // No permits consumed assert_eq!(guard.granted_bytes(), 0); // No permits consumed
assert_eq!(manager.used_bytes(), 0); assert_eq!(manager.used_bytes(), 0);
assert!(guard.try_acquire_additional(3 * PERMIT_GRANULARITY_BYTES)); // Lazy allocation assert!(guard.request_additional(3 * PERMIT_GRANULARITY_BYTES)); // Lazy allocation
assert_eq!(guard.granted_bytes(), 3 * PERMIT_GRANULARITY_BYTES); assert_eq!(guard.granted_bytes(), 3 * PERMIT_GRANULARITY_BYTES);
} }
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_blocks_and_unblocks() {
let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics);
// First guard takes 9MB, leaving only 1MB available
let mut guard1 = manager.try_acquire(9 * PERMIT_GRANULARITY_BYTES).unwrap();
assert_eq!(manager.used_bytes(), 9 * PERMIT_GRANULARITY_BYTES);
// Spawn a task that will block trying to acquire additional 5MB (needs total 10MB available)
let manager_clone = manager.clone();
let waiter = tokio::spawn(async move {
let mut guard2 = manager_clone.try_acquire(0).unwrap();
// This will block until enough memory is available
guard2
.acquire_additional(5 * PERMIT_GRANULARITY_BYTES)
.await
.unwrap();
guard2
});
sleep(Duration::from_millis(10)).await;
// Release 5MB from guard1 - this should unblock the waiter
assert!(guard1.release_partial(5 * PERMIT_GRANULARITY_BYTES));
// Waiter should complete now
let guard2 = waiter.await.unwrap();
assert_eq!(guard2.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
// Total: guard1 has 4MB, guard2 has 5MB = 9MB
assert_eq!(manager.used_bytes(), 9 * PERMIT_GRANULARITY_BYTES);
}
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_exceeds_total_limit() {
let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics);
let mut guard = manager.try_acquire(8 * PERMIT_GRANULARITY_BYTES).unwrap();
// Try to acquire additional 5MB - would exceed total limit of 10MB
let result = guard.acquire_additional(5 * PERMIT_GRANULARITY_BYTES).await;
assert!(result.is_err());
// Guard should remain unchanged
assert_eq!(guard.granted_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 8 * PERMIT_GRANULARITY_BYTES);
}
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_success() {
let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics);
let mut guard = manager.try_acquire(3 * PERMIT_GRANULARITY_BYTES).unwrap();
assert_eq!(manager.used_bytes(), 3 * PERMIT_GRANULARITY_BYTES);
// Acquire additional 4MB - should succeed
guard
.acquire_additional(4 * PERMIT_GRANULARITY_BYTES)
.await
.unwrap();
assert_eq!(guard.granted_bytes(), 7 * PERMIT_GRANULARITY_BYTES);
assert_eq!(manager.used_bytes(), 7 * PERMIT_GRANULARITY_BYTES);
}
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_with_policy_wait_success() {
use crate::policy::OnExhaustedPolicy;
let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics);
let mut guard1 = manager.try_acquire(8 * PERMIT_GRANULARITY_BYTES).unwrap();
let manager_clone = manager.clone();
let waiter = tokio::spawn(async move {
let mut guard2 = manager_clone.try_acquire(0).unwrap();
// Wait policy with 1 second timeout
guard2
.acquire_additional_with_policy(
5 * PERMIT_GRANULARITY_BYTES,
OnExhaustedPolicy::Wait {
timeout: Duration::from_secs(1),
},
)
.await
.unwrap();
guard2
});
sleep(Duration::from_millis(10)).await;
// Release memory to unblock waiter
assert!(guard1.release_partial(5 * PERMIT_GRANULARITY_BYTES));
let guard2 = waiter.await.unwrap();
assert_eq!(guard2.granted_bytes(), 5 * PERMIT_GRANULARITY_BYTES);
}
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_with_policy_wait_timeout() {
use crate::policy::OnExhaustedPolicy;
let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics);
// Take all memory
let _guard1 = manager.try_acquire(10 * PERMIT_GRANULARITY_BYTES).unwrap();
let mut guard2 = manager.try_acquire(0).unwrap();
// Try to acquire with short timeout - should timeout
let result = guard2
.acquire_additional_with_policy(
5 * PERMIT_GRANULARITY_BYTES,
OnExhaustedPolicy::Wait {
timeout: Duration::from_millis(50),
},
)
.await;
assert!(result.is_err());
assert_eq!(guard2.granted_bytes(), 0);
}
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_with_policy_fail() {
use crate::policy::OnExhaustedPolicy;
let limit = 10 * PERMIT_GRANULARITY_BYTES;
let manager = MemoryManager::new(limit, NoOpMetrics);
let _guard1 = manager.try_acquire(8 * PERMIT_GRANULARITY_BYTES).unwrap();
let mut guard2 = manager.try_acquire(0).unwrap();
// Fail policy - should return error immediately
let result = guard2
.acquire_additional_with_policy(5 * PERMIT_GRANULARITY_BYTES, OnExhaustedPolicy::Fail)
.await;
assert!(result.is_err());
assert_eq!(guard2.granted_bytes(), 0);
}
#[tokio::test(flavor = "current_thread")]
async fn test_acquire_additional_unlimited() {
let manager = MemoryManager::new(0, NoOpMetrics); // Unlimited
let mut guard = manager.try_acquire(0).unwrap();
// Should always succeed with unlimited manager
guard
.acquire_additional(1000 * PERMIT_GRANULARITY_BYTES)
.await
.unwrap();
assert_eq!(guard.granted_bytes(), 0);
assert_eq!(manager.used_bytes(), 0);
}

View File

@@ -36,7 +36,8 @@ pub mod create_database;
pub mod create_flow; pub mod create_flow;
pub mod create_logical_tables; pub mod create_logical_tables;
pub mod create_table; pub mod create_table;
pub(crate) use create_table::{CreateRequestBuilder, build_template_from_raw_table_info}; mod create_table_template;
pub(crate) use create_table_template::{CreateRequestBuilder, build_template_from_raw_table_info};
pub mod create_view; pub mod create_view;
pub mod drop_database; pub mod drop_database;
pub mod drop_flow; pub mod drop_flow;

View File

@@ -30,7 +30,7 @@ use serde::{Deserialize, Serialize};
use snafu::ResultExt; use snafu::ResultExt;
use store_api::metadata::ColumnMetadata; use store_api::metadata::ColumnMetadata;
use store_api::metric_engine_consts::ALTER_PHYSICAL_EXTENSION_KEY; use store_api::metric_engine_consts::ALTER_PHYSICAL_EXTENSION_KEY;
use store_api::storage::RegionNumber; use store_api::storage::{RegionId, RegionNumber};
use strum::AsRefStr; use strum::AsRefStr;
use table::metadata::{RawTableInfo, TableId}; use table::metadata::{RawTableInfo, TableId};
@@ -286,7 +286,14 @@ impl CreateTablesData {
.flat_map(|(task, table_id)| { .flat_map(|(task, table_id)| {
if table_id.is_none() { if table_id.is_none() {
let table_info = task.table_info.clone(); let table_info = task.table_info.clone();
let table_route = TableRouteValue::logical(self.physical_table_id); let region_ids = self
.physical_region_numbers
.iter()
.map(|region_number| {
RegionId::new(table_info.ident.table_id, *region_number)
})
.collect();
let table_route = TableRouteValue::logical(self.physical_table_id, region_ids);
Some((table_info, table_route)) Some((table_info, table_route))
} else { } else {
None None

View File

@@ -22,7 +22,7 @@ use store_api::storage::{RegionId, TableId};
use table::metadata::RawTableInfo; use table::metadata::RawTableInfo;
use crate::ddl::create_logical_tables::CreateLogicalTablesProcedure; use crate::ddl::create_logical_tables::CreateLogicalTablesProcedure;
use crate::ddl::create_table::template::{ use crate::ddl::create_table_template::{
CreateRequestBuilder, build_template, build_template_from_raw_table_info, CreateRequestBuilder, build_template, build_template_from_raw_table_info,
}; };
use crate::ddl::utils::region_storage_path; use crate::ddl::utils::region_storage_path;

View File

@@ -12,99 +12,74 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
pub(crate) mod executor;
pub(crate) mod template;
use std::collections::HashMap; use std::collections::HashMap;
use api::v1::CreateTableExpr; use api::v1::region::region_request::Body as PbRegionRequest;
use api::v1::region::{RegionRequest, RegionRequestHeader};
use async_trait::async_trait; use async_trait::async_trait;
use common_error::ext::BoxedError; use common_error::ext::BoxedError;
use common_procedure::error::{ use common_procedure::error::{
ExternalSnafu, FromJsonSnafu, Result as ProcedureResult, ToJsonSnafu, ExternalSnafu, FromJsonSnafu, Result as ProcedureResult, ToJsonSnafu,
}; };
use common_procedure::{Context as ProcedureContext, LockKey, Procedure, ProcedureId, Status}; use common_procedure::{Context as ProcedureContext, LockKey, Procedure, ProcedureId, Status};
use common_telemetry::info; use common_telemetry::tracing_context::TracingContext;
use common_telemetry::{info, warn};
use futures::future::join_all;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use snafu::{OptionExt, ResultExt}; use snafu::{OptionExt, ResultExt, ensure};
use store_api::metadata::ColumnMetadata; use store_api::metadata::ColumnMetadata;
use store_api::storage::RegionNumber; use store_api::metric_engine_consts::TABLE_COLUMN_METADATA_EXTENSION_KEY;
use store_api::storage::{RegionId, RegionNumber};
use strum::AsRefStr; use strum::AsRefStr;
use table::metadata::{RawTableInfo, TableId}; use table::metadata::{RawTableInfo, TableId};
use table::table_name::TableName;
use table::table_reference::TableReference; use table::table_reference::TableReference;
pub(crate) use template::{CreateRequestBuilder, build_template_from_raw_table_info};
use crate::ddl::create_table::executor::CreateTableExecutor; use crate::ddl::create_table_template::{CreateRequestBuilder, build_template};
use crate::ddl::create_table::template::build_template; use crate::ddl::utils::raw_table_info::update_table_info_column_ids;
use crate::ddl::utils::map_to_procedure_error; use crate::ddl::utils::{
add_peer_context_if_needed, convert_region_routes_to_detecting_regions,
extract_column_metadatas, map_to_procedure_error, region_storage_path,
};
use crate::ddl::{DdlContext, TableMetadata}; use crate::ddl::{DdlContext, TableMetadata};
use crate::error::{self, Result}; use crate::error::{self, Result};
use crate::key::table_route::PhysicalTableRouteValue; use crate::key::table_name::TableNameKey;
use crate::key::table_route::{PhysicalTableRouteValue, TableRouteValue};
use crate::lock_key::{CatalogLock, SchemaLock, TableNameLock}; use crate::lock_key::{CatalogLock, SchemaLock, TableNameLock};
use crate::metrics; use crate::metrics;
use crate::region_keeper::OperatingRegionGuard; use crate::region_keeper::OperatingRegionGuard;
use crate::rpc::ddl::CreateTableTask; use crate::rpc::ddl::CreateTableTask;
use crate::rpc::router::{RegionRoute, operating_leader_regions}; use crate::rpc::router::{
RegionRoute, find_leader_regions, find_leaders, operating_leader_regions,
};
pub struct CreateTableProcedure { pub struct CreateTableProcedure {
pub context: DdlContext, pub context: DdlContext,
/// The serializable data. pub creator: TableCreator,
pub data: CreateTableData,
/// The guards of opening.
pub opening_regions: Vec<OperatingRegionGuard>,
/// The executor of the procedure.
pub executor: CreateTableExecutor,
}
fn build_executor_from_create_table_data(
create_table_expr: &CreateTableExpr,
) -> Result<CreateTableExecutor> {
let template = build_template(create_table_expr)?;
let builder = CreateRequestBuilder::new(template, None);
let table_name = TableName::new(
create_table_expr.catalog_name.clone(),
create_table_expr.schema_name.clone(),
create_table_expr.table_name.clone(),
);
let executor =
CreateTableExecutor::new(table_name, create_table_expr.create_if_not_exists, builder);
Ok(executor)
} }
impl CreateTableProcedure { impl CreateTableProcedure {
pub const TYPE_NAME: &'static str = "metasrv-procedure::CreateTable"; pub const TYPE_NAME: &'static str = "metasrv-procedure::CreateTable";
pub fn new(task: CreateTableTask, context: DdlContext) -> Result<Self> { pub fn new(task: CreateTableTask, context: DdlContext) -> Self {
let executor = build_executor_from_create_table_data(&task.create_table)?; Self {
Ok(Self {
context, context,
data: CreateTableData::new(task), creator: TableCreator::new(task),
opening_regions: vec![], }
executor,
})
} }
pub fn from_json(json: &str, context: DdlContext) -> ProcedureResult<Self> { pub fn from_json(json: &str, context: DdlContext) -> ProcedureResult<Self> {
let data: CreateTableData = serde_json::from_str(json).context(FromJsonSnafu)?; let data = serde_json::from_str(json).context(FromJsonSnafu)?;
let create_table_expr = &data.task.create_table;
let executor = build_executor_from_create_table_data(create_table_expr)
.map_err(BoxedError::new)
.context(ExternalSnafu {
clean_poisons: false,
})?;
Ok(CreateTableProcedure { Ok(CreateTableProcedure {
context, context,
data, creator: TableCreator {
opening_regions: vec![], data,
executor, opening_regions: vec![],
},
}) })
} }
fn table_info(&self) -> &RawTableInfo { fn table_info(&self) -> &RawTableInfo {
&self.data.task.table_info &self.creator.data.task.table_info
} }
pub(crate) fn table_id(&self) -> TableId { pub(crate) fn table_id(&self) -> TableId {
@@ -112,7 +87,8 @@ impl CreateTableProcedure {
} }
fn region_wal_options(&self) -> Result<&HashMap<RegionNumber, String>> { fn region_wal_options(&self) -> Result<&HashMap<RegionNumber, String>> {
self.data self.creator
.data
.region_wal_options .region_wal_options
.as_ref() .as_ref()
.context(error::UnexpectedSnafu { .context(error::UnexpectedSnafu {
@@ -121,7 +97,8 @@ impl CreateTableProcedure {
} }
fn table_route(&self) -> Result<&PhysicalTableRouteValue> { fn table_route(&self) -> Result<&PhysicalTableRouteValue> {
self.data self.creator
.data
.table_route .table_route
.as_ref() .as_ref()
.context(error::UnexpectedSnafu { .context(error::UnexpectedSnafu {
@@ -129,6 +106,17 @@ impl CreateTableProcedure {
}) })
} }
#[cfg(any(test, feature = "testing"))]
pub fn set_allocated_metadata(
&mut self,
table_id: TableId,
table_route: PhysicalTableRouteValue,
region_wal_options: HashMap<RegionNumber, String>,
) {
self.creator
.set_allocated_metadata(table_id, table_route, region_wal_options)
}
/// On the prepare step, it performs: /// On the prepare step, it performs:
/// - Checks whether the table exists. /// - Checks whether the table exists.
/// - Allocates the table id. /// - Allocates the table id.
@@ -137,16 +125,31 @@ impl CreateTableProcedure {
/// - TableName exists and `create_if_not_exists` is false. /// - TableName exists and `create_if_not_exists` is false.
/// - Failed to allocate [TableMetadata]. /// - Failed to allocate [TableMetadata].
pub(crate) async fn on_prepare(&mut self) -> Result<Status> { pub(crate) async fn on_prepare(&mut self) -> Result<Status> {
let table_id = self let expr = &self.creator.data.task.create_table;
.executor let table_name_value = self
.on_prepare(&self.context.table_metadata_manager) .context
.table_metadata_manager
.table_name_manager()
.get(TableNameKey::new(
&expr.catalog_name,
&expr.schema_name,
&expr.table_name,
))
.await?; .await?;
// Return the table id if the table already exists.
if let Some(table_id) = table_id { if let Some(value) = table_name_value {
ensure!(
expr.create_if_not_exists,
error::TableAlreadyExistsSnafu {
table_name: self.creator.data.table_ref().to_string(),
}
);
let table_id = value.table_id();
return Ok(Status::done_with_output(table_id)); return Ok(Status::done_with_output(table_id));
} }
self.data.state = CreateTableState::DatanodeCreateRegions; self.creator.data.state = CreateTableState::DatanodeCreateRegions;
let TableMetadata { let TableMetadata {
table_id, table_id,
table_route, table_route,
@@ -154,13 +157,23 @@ impl CreateTableProcedure {
} = self } = self
.context .context
.table_metadata_allocator .table_metadata_allocator
.create(&self.data.task) .create(&self.creator.data.task)
.await?; .await?;
self.set_allocated_metadata(table_id, table_route, region_wal_options); self.creator
.set_allocated_metadata(table_id, table_route, region_wal_options);
Ok(Status::executing(true)) Ok(Status::executing(true))
} }
pub fn new_region_request_builder(
&self,
physical_table_id: Option<TableId>,
) -> Result<CreateRequestBuilder> {
let create_table_expr = &self.creator.data.task.create_table;
let template = build_template(create_table_expr)?;
Ok(CreateRequestBuilder::new(template, physical_table_id))
}
/// Creates regions on datanodes /// Creates regions on datanodes
/// ///
/// Abort(non-retry): /// Abort(non-retry):
@@ -174,29 +187,90 @@ impl CreateTableProcedure {
/// - [Code::Unavailable](tonic::status::Code::Unavailable) /// - [Code::Unavailable](tonic::status::Code::Unavailable)
pub async fn on_datanode_create_regions(&mut self) -> Result<Status> { pub async fn on_datanode_create_regions(&mut self) -> Result<Status> {
let table_route = self.table_route()?.clone(); let table_route = self.table_route()?.clone();
let request_builder = self.new_region_request_builder(None)?;
// Registers opening regions // Registers opening regions
let guards = self.register_opening_regions(&self.context, &table_route.region_routes)?; let guards = self
.creator
.register_opening_regions(&self.context, &table_route.region_routes)?;
if !guards.is_empty() { if !guards.is_empty() {
self.opening_regions = guards; self.creator.opening_regions = guards;
} }
self.create_regions(&table_route.region_routes).await self.create_regions(&table_route.region_routes, request_builder)
.await
} }
async fn create_regions(&mut self, region_routes: &[RegionRoute]) -> Result<Status> { async fn create_regions(
let table_id = self.table_id(); &mut self,
region_routes: &[RegionRoute],
request_builder: CreateRequestBuilder,
) -> Result<Status> {
let create_table_data = &self.creator.data;
// Safety: the region_wal_options must be allocated
let region_wal_options = self.region_wal_options()?; let region_wal_options = self.region_wal_options()?;
let column_metadatas = self let create_table_expr = &create_table_data.task.create_table;
.executor let catalog = &create_table_expr.catalog_name;
.on_create_regions( let schema = &create_table_expr.schema_name;
&self.context.node_manager, let storage_path = region_storage_path(catalog, schema);
table_id, let leaders = find_leaders(region_routes);
region_routes, let mut create_region_tasks = Vec::with_capacity(leaders.len());
region_wal_options,
)
.await?;
self.data.column_metadatas = column_metadatas; let partition_exprs = region_routes
self.data.state = CreateTableState::CreateMetadata; .iter()
.map(|r| (r.region.id.region_number(), r.region.partition_expr()))
.collect();
for datanode in leaders {
let requester = self.context.node_manager.datanode(&datanode).await;
let regions = find_leader_regions(region_routes, &datanode);
let mut requests = Vec::with_capacity(regions.len());
for region_number in regions {
let region_id = RegionId::new(self.table_id(), region_number);
let create_region_request = request_builder.build_one(
region_id,
storage_path.clone(),
region_wal_options,
&partition_exprs,
);
requests.push(PbRegionRequest::Create(create_region_request));
}
for request in requests {
let request = RegionRequest {
header: Some(RegionRequestHeader {
tracing_context: TracingContext::from_current_span().to_w3c(),
..Default::default()
}),
body: Some(request),
};
let datanode = datanode.clone();
let requester = requester.clone();
create_region_tasks.push(async move {
requester
.handle(request)
.await
.map_err(add_peer_context_if_needed(datanode))
});
}
}
let mut results = join_all(create_region_tasks)
.await
.into_iter()
.collect::<Result<Vec<_>>>()?;
if let Some(column_metadatas) =
extract_column_metadatas(&mut results, TABLE_COLUMN_METADATA_EXTENSION_KEY)?
{
self.creator.data.column_metadatas = column_metadatas;
} else {
warn!(
"creating table result doesn't contains extension key `{TABLE_COLUMN_METADATA_EXTENSION_KEY}`,leaving the table's column metadata unchanged"
);
}
self.creator.data.state = CreateTableState::CreateMetadata;
Ok(Status::executing(true)) Ok(Status::executing(true))
} }
@@ -206,33 +280,107 @@ impl CreateTableProcedure {
/// - Failed to create table metadata. /// - Failed to create table metadata.
async fn on_create_metadata(&mut self, pid: ProcedureId) -> Result<Status> { async fn on_create_metadata(&mut self, pid: ProcedureId) -> Result<Status> {
let table_id = self.table_id(); let table_id = self.table_id();
let table_ref = self.data.table_ref(); let table_ref = self.creator.data.table_ref();
let manager = &self.context.table_metadata_manager; let manager = &self.context.table_metadata_manager;
let raw_table_info = self.table_info().clone(); let mut raw_table_info = self.table_info().clone();
if !self.creator.data.column_metadatas.is_empty() {
update_table_info_column_ids(&mut raw_table_info, &self.creator.data.column_metadatas);
}
// Safety: the region_wal_options must be allocated. // Safety: the region_wal_options must be allocated.
let region_wal_options = self.region_wal_options()?.clone(); let region_wal_options = self.region_wal_options()?.clone();
// Safety: the table_route must be allocated. // Safety: the table_route must be allocated.
let physical_table_route = self.table_route()?.clone(); let physical_table_route = self.table_route()?.clone();
self.executor let detecting_regions =
.on_create_metadata( convert_region_routes_to_detecting_regions(&physical_table_route.region_routes);
manager, let table_route = TableRouteValue::Physical(physical_table_route);
&self.context.region_failure_detector_controller, manager
raw_table_info, .create_table_metadata(raw_table_info, table_route, region_wal_options)
&self.data.column_metadatas,
physical_table_route,
region_wal_options,
)
.await?; .await?;
self.context
.register_failure_detectors(detecting_regions)
.await;
info!( info!(
"Successfully created table: {}, table_id: {}, procedure_id: {}", "Successfully created table: {}, table_id: {}, procedure_id: {}",
table_ref, table_id, pid table_ref, table_id, pid
); );
self.opening_regions.clear(); self.creator.opening_regions.clear();
Ok(Status::done_with_output(table_id)) Ok(Status::done_with_output(table_id))
} }
}
#[async_trait]
impl Procedure for CreateTableProcedure {
fn type_name(&self) -> &str {
Self::TYPE_NAME
}
fn recover(&mut self) -> ProcedureResult<()> {
// Only registers regions if the table route is allocated.
if let Some(x) = &self.creator.data.table_route {
self.creator.opening_regions = self
.creator
.register_opening_regions(&self.context, &x.region_routes)
.map_err(BoxedError::new)
.context(ExternalSnafu {
clean_poisons: false,
})?;
}
Ok(())
}
async fn execute(&mut self, ctx: &ProcedureContext) -> ProcedureResult<Status> {
let state = &self.creator.data.state;
let _timer = metrics::METRIC_META_PROCEDURE_CREATE_TABLE
.with_label_values(&[state.as_ref()])
.start_timer();
match state {
CreateTableState::Prepare => self.on_prepare().await,
CreateTableState::DatanodeCreateRegions => self.on_datanode_create_regions().await,
CreateTableState::CreateMetadata => self.on_create_metadata(ctx.procedure_id).await,
}
.map_err(map_to_procedure_error)
}
fn dump(&self) -> ProcedureResult<String> {
serde_json::to_string(&self.creator.data).context(ToJsonSnafu)
}
fn lock_key(&self) -> LockKey {
let table_ref = &self.creator.data.table_ref();
LockKey::new(vec![
CatalogLock::Read(table_ref.catalog).into(),
SchemaLock::read(table_ref.catalog, table_ref.schema).into(),
TableNameLock::new(table_ref.catalog, table_ref.schema, table_ref.table).into(),
])
}
}
pub struct TableCreator {
/// The serializable data.
pub data: CreateTableData,
/// The guards of opening.
pub opening_regions: Vec<OperatingRegionGuard>,
}
impl TableCreator {
pub fn new(task: CreateTableTask) -> Self {
Self {
data: CreateTableData {
state: CreateTableState::Prepare,
column_metadatas: vec![],
task,
table_route: None,
region_wal_options: None,
},
opening_regions: vec![],
}
}
/// Registers and returns the guards of the opening region if they don't exist. /// Registers and returns the guards of the opening region if they don't exist.
fn register_opening_regions( fn register_opening_regions(
@@ -241,6 +389,7 @@ impl CreateTableProcedure {
region_routes: &[RegionRoute], region_routes: &[RegionRoute],
) -> Result<Vec<OperatingRegionGuard>> { ) -> Result<Vec<OperatingRegionGuard>> {
let opening_regions = operating_leader_regions(region_routes); let opening_regions = operating_leader_regions(region_routes);
if self.opening_regions.len() == opening_regions.len() { if self.opening_regions.len() == opening_regions.len() {
return Ok(vec![]); return Ok(vec![]);
} }
@@ -260,7 +409,7 @@ impl CreateTableProcedure {
Ok(opening_region_guards) Ok(opening_region_guards)
} }
pub fn set_allocated_metadata( fn set_allocated_metadata(
&mut self, &mut self,
table_id: TableId, table_id: TableId,
table_route: PhysicalTableRouteValue, table_route: PhysicalTableRouteValue,
@@ -272,56 +421,6 @@ impl CreateTableProcedure {
} }
} }
#[async_trait]
impl Procedure for CreateTableProcedure {
fn type_name(&self) -> &str {
Self::TYPE_NAME
}
fn recover(&mut self) -> ProcedureResult<()> {
// Only registers regions if the table route is allocated.
if let Some(x) = &self.data.table_route {
self.opening_regions = self
.register_opening_regions(&self.context, &x.region_routes)
.map_err(BoxedError::new)
.context(ExternalSnafu {
clean_poisons: false,
})?;
}
Ok(())
}
async fn execute(&mut self, ctx: &ProcedureContext) -> ProcedureResult<Status> {
let state = &self.data.state;
let _timer = metrics::METRIC_META_PROCEDURE_CREATE_TABLE
.with_label_values(&[state.as_ref()])
.start_timer();
match state {
CreateTableState::Prepare => self.on_prepare().await,
CreateTableState::DatanodeCreateRegions => self.on_datanode_create_regions().await,
CreateTableState::CreateMetadata => self.on_create_metadata(ctx.procedure_id).await,
}
.map_err(map_to_procedure_error)
}
fn dump(&self) -> ProcedureResult<String> {
serde_json::to_string(&self.data).context(ToJsonSnafu)
}
fn lock_key(&self) -> LockKey {
let table_ref = &self.data.table_ref();
LockKey::new(vec![
CatalogLock::Read(table_ref.catalog).into(),
SchemaLock::read(table_ref.catalog, table_ref.schema).into(),
TableNameLock::new(table_ref.catalog, table_ref.schema, table_ref.table).into(),
])
}
}
#[derive(Debug, Clone, Serialize, Deserialize, AsRefStr, PartialEq)] #[derive(Debug, Clone, Serialize, Deserialize, AsRefStr, PartialEq)]
pub enum CreateTableState { pub enum CreateTableState {
/// Prepares to create the table /// Prepares to create the table
@@ -345,16 +444,6 @@ pub struct CreateTableData {
} }
impl CreateTableData { impl CreateTableData {
pub fn new(task: CreateTableTask) -> Self {
CreateTableData {
state: CreateTableState::Prepare,
column_metadatas: vec![],
task,
table_route: None,
region_wal_options: None,
}
}
fn table_ref(&self) -> TableReference<'_> { fn table_ref(&self) -> TableReference<'_> {
self.task.table_ref() self.task.table_ref()
} }

View File

@@ -1,203 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
use std::collections::HashMap;
use api::v1::region::region_request::Body as PbRegionRequest;
use api::v1::region::{RegionRequest, RegionRequestHeader};
use common_telemetry::tracing_context::TracingContext;
use common_telemetry::warn;
use futures::future::join_all;
use snafu::ensure;
use store_api::metadata::ColumnMetadata;
use store_api::metric_engine_consts::TABLE_COLUMN_METADATA_EXTENSION_KEY;
use store_api::storage::{RegionId, RegionNumber};
use table::metadata::{RawTableInfo, TableId};
use table::table_name::TableName;
use crate::ddl::utils::raw_table_info::update_table_info_column_ids;
use crate::ddl::utils::{
add_peer_context_if_needed, convert_region_routes_to_detecting_regions,
extract_column_metadatas, region_storage_path,
};
use crate::ddl::{CreateRequestBuilder, RegionFailureDetectorControllerRef};
use crate::error::{self, Result};
use crate::key::TableMetadataManagerRef;
use crate::key::table_name::TableNameKey;
use crate::key::table_route::{PhysicalTableRouteValue, TableRouteValue};
use crate::node_manager::NodeManagerRef;
use crate::rpc::router::{RegionRoute, find_leader_regions, find_leaders};
/// [CreateTableExecutor] performs:
/// - Creates the metadata of the table.
/// - Creates the regions on the Datanode nodes.
pub struct CreateTableExecutor {
create_if_not_exists: bool,
table_name: TableName,
builder: CreateRequestBuilder,
}
impl CreateTableExecutor {
/// Creates a new [`CreateTableExecutor`].
pub fn new(
table_name: TableName,
create_if_not_exists: bool,
builder: CreateRequestBuilder,
) -> Self {
Self {
create_if_not_exists,
table_name,
builder,
}
}
/// On the prepare step, it performs:
/// - Checks whether the table exists.
/// - Returns the table id if the table exists.
///
/// Abort(non-retry):
/// - Table exists and `create_if_not_exists` is `false`.
/// - Failed to get the table name value.
pub async fn on_prepare(
&self,
table_metadata_manager: &TableMetadataManagerRef,
) -> Result<Option<TableId>> {
let table_name_value = table_metadata_manager
.table_name_manager()
.get(TableNameKey::new(
&self.table_name.catalog_name,
&self.table_name.schema_name,
&self.table_name.table_name,
))
.await?;
if let Some(value) = table_name_value {
ensure!(
self.create_if_not_exists,
error::TableAlreadyExistsSnafu {
table_name: self.table_name.to_string(),
}
);
return Ok(Some(value.table_id()));
}
Ok(None)
}
pub async fn on_create_regions(
&self,
node_manager: &NodeManagerRef,
table_id: TableId,
region_routes: &[RegionRoute],
region_wal_options: &HashMap<RegionNumber, String>,
) -> Result<Vec<ColumnMetadata>> {
let storage_path =
region_storage_path(&self.table_name.catalog_name, &self.table_name.schema_name);
let leaders = find_leaders(region_routes);
let mut create_region_tasks = Vec::with_capacity(leaders.len());
let partition_exprs = region_routes
.iter()
.map(|r| (r.region.id.region_number(), r.region.partition_expr()))
.collect::<HashMap<_, _>>();
for datanode in leaders {
let requester = node_manager.datanode(&datanode).await;
let regions = find_leader_regions(region_routes, &datanode);
let mut requests = Vec::with_capacity(regions.len());
for region_number in regions {
let region_id = RegionId::new(table_id, region_number);
let create_region_request = self.builder.build_one(
region_id,
storage_path.clone(),
region_wal_options,
&partition_exprs,
);
requests.push(PbRegionRequest::Create(create_region_request));
}
for request in requests {
let request = RegionRequest {
header: Some(RegionRequestHeader {
tracing_context: TracingContext::from_current_span().to_w3c(),
..Default::default()
}),
body: Some(request),
};
let datanode = datanode.clone();
let requester = requester.clone();
create_region_tasks.push(async move {
requester
.handle(request)
.await
.map_err(add_peer_context_if_needed(datanode))
});
}
}
let mut results = join_all(create_region_tasks)
.await
.into_iter()
.collect::<Result<Vec<_>>>()?;
let column_metadatas = if let Some(column_metadatas) =
extract_column_metadatas(&mut results, TABLE_COLUMN_METADATA_EXTENSION_KEY)?
{
column_metadatas
} else {
warn!(
"creating table result doesn't contains extension key `{TABLE_COLUMN_METADATA_EXTENSION_KEY}`,leaving the table's column metadata unchanged"
);
vec![]
};
Ok(column_metadatas)
}
/// Creates table metadata
///
/// Abort(non-retry):
/// - Failed to create table metadata.
pub async fn on_create_metadata(
&self,
table_metadata_manager: &TableMetadataManagerRef,
region_failure_detector_controller: &RegionFailureDetectorControllerRef,
mut raw_table_info: RawTableInfo,
column_metadatas: &[ColumnMetadata],
table_route: PhysicalTableRouteValue,
region_wal_options: HashMap<RegionNumber, String>,
) -> Result<()> {
if !column_metadatas.is_empty() {
update_table_info_column_ids(&mut raw_table_info, column_metadatas);
}
let detecting_regions =
convert_region_routes_to_detecting_regions(&table_route.region_routes);
let table_route = TableRouteValue::Physical(table_route);
table_metadata_manager
.create_table_metadata(raw_table_info, table_route, region_wal_options)
.await?;
region_failure_detector_controller
.register_failure_detectors(detecting_regions)
.await;
Ok(())
}
/// Returns the builder of the executor.
pub fn builder(&self) -> &CreateRequestBuilder {
&self.builder
}
}

View File

@@ -120,13 +120,7 @@ impl State for DropDatabaseExecutor {
.await?; .await?;
executor.invalidate_table_cache(ddl_ctx).await?; executor.invalidate_table_cache(ddl_ctx).await?;
executor executor
.on_drop_regions( .on_drop_regions(ddl_ctx, &self.physical_region_routes, true)
&ddl_ctx.node_manager,
&ddl_ctx.leader_region_registry,
&self.physical_region_routes,
true,
false,
)
.await?; .await?;
info!("Table: {}({}) is dropped", self.table_name, self.table_id); info!("Table: {}({}) is dropped", self.table_name, self.table_id);

View File

@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
pub mod executor; pub(crate) mod executor;
mod metadata; mod metadata;
use std::collections::HashMap; use std::collections::HashMap;
@@ -156,13 +156,7 @@ impl DropTableProcedure {
pub async fn on_datanode_drop_regions(&mut self) -> Result<Status> { pub async fn on_datanode_drop_regions(&mut self) -> Result<Status> {
self.executor self.executor
.on_drop_regions( .on_drop_regions(&self.context, &self.data.physical_region_routes, false)
&self.context.node_manager,
&self.context.leader_region_registry,
&self.data.physical_region_routes,
false,
false,
)
.await?; .await?;
self.data.state = DropTableState::DeleteTombstone; self.data.state = DropTableState::DeleteTombstone;
Ok(Status::executing(true)) Ok(Status::executing(true))

View File

@@ -36,8 +36,6 @@ use crate::error::{self, Result};
use crate::instruction::CacheIdent; use crate::instruction::CacheIdent;
use crate::key::table_name::TableNameKey; use crate::key::table_name::TableNameKey;
use crate::key::table_route::TableRouteValue; use crate::key::table_route::TableRouteValue;
use crate::node_manager::NodeManagerRef;
use crate::region_registry::LeaderRegionRegistryRef;
use crate::rpc::router::{ use crate::rpc::router::{
RegionRoute, find_follower_regions, find_followers, find_leader_regions, find_leaders, RegionRoute, find_follower_regions, find_followers, find_leader_regions, find_leaders,
operating_leader_regions, operating_leader_regions,
@@ -214,18 +212,16 @@ impl DropTableExecutor {
/// Drops region on datanode. /// Drops region on datanode.
pub async fn on_drop_regions( pub async fn on_drop_regions(
&self, &self,
node_manager: &NodeManagerRef, ctx: &DdlContext,
leader_region_registry: &LeaderRegionRegistryRef,
region_routes: &[RegionRoute], region_routes: &[RegionRoute],
fast_path: bool, fast_path: bool,
force: bool,
) -> Result<()> { ) -> Result<()> {
// Drops leader regions on datanodes. // Drops leader regions on datanodes.
let leaders = find_leaders(region_routes); let leaders = find_leaders(region_routes);
let mut drop_region_tasks = Vec::with_capacity(leaders.len()); let mut drop_region_tasks = Vec::with_capacity(leaders.len());
let table_id = self.table_id; let table_id = self.table_id;
for datanode in leaders { for datanode in leaders {
let requester = node_manager.datanode(&datanode).await; let requester = ctx.node_manager.datanode(&datanode).await;
let regions = find_leader_regions(region_routes, &datanode); let regions = find_leader_regions(region_routes, &datanode);
let region_ids = regions let region_ids = regions
.iter() .iter()
@@ -242,7 +238,6 @@ impl DropTableExecutor {
body: Some(region_request::Body::Drop(PbDropRegionRequest { body: Some(region_request::Body::Drop(PbDropRegionRequest {
region_id: region_id.as_u64(), region_id: region_id.as_u64(),
fast_path, fast_path,
force,
})), })),
}; };
let datanode = datanode.clone(); let datanode = datanode.clone();
@@ -267,7 +262,7 @@ impl DropTableExecutor {
let followers = find_followers(region_routes); let followers = find_followers(region_routes);
let mut close_region_tasks = Vec::with_capacity(followers.len()); let mut close_region_tasks = Vec::with_capacity(followers.len());
for datanode in followers { for datanode in followers {
let requester = node_manager.datanode(&datanode).await; let requester = ctx.node_manager.datanode(&datanode).await;
let regions = find_follower_regions(region_routes, &datanode); let regions = find_follower_regions(region_routes, &datanode);
let region_ids = regions let region_ids = regions
.iter() .iter()
@@ -312,7 +307,8 @@ impl DropTableExecutor {
// Deletes the leader region from registry. // Deletes the leader region from registry.
let region_ids = operating_leader_regions(region_routes); let region_ids = operating_leader_regions(region_routes);
leader_region_registry.batch_delete(region_ids.into_iter().map(|(region_id, _)| region_id)); ctx.leader_region_registry
.batch_delete(region_ids.into_iter().map(|(region_id, _)| region_id));
Ok(()) Ok(())
} }

View File

@@ -128,6 +128,7 @@ pub fn build_raw_table_info_from_expr(expr: &CreateTableExpr) -> RawTableInfo {
value_indices: vec![], value_indices: vec![],
engine: expr.engine.clone(), engine: expr.engine.clone(),
next_column_id: expr.column_defs.len() as u32, next_column_id: expr.column_defs.len() as u32,
region_numbers: vec![],
options: TableOptions::try_from_iter(&expr.table_options).unwrap(), options: TableOptions::try_from_iter(&expr.table_options).unwrap(),
created_on: DateTime::default(), created_on: DateTime::default(),
updated_on: DateTime::default(), updated_on: DateTime::default(),

View File

@@ -166,7 +166,7 @@ async fn test_on_prepare_logical_table_exists_err() {
.table_metadata_manager .table_metadata_manager
.create_logical_tables_metadata(vec![( .create_logical_tables_metadata(vec![(
task.table_info.clone(), task.table_info.clone(),
TableRouteValue::logical(1024), TableRouteValue::logical(1024, vec![RegionId::new(1025, 1)]),
)]) )])
.await .await
.unwrap(); .unwrap();
@@ -208,7 +208,7 @@ async fn test_on_prepare_with_create_if_table_exists() {
.table_metadata_manager .table_metadata_manager
.create_logical_tables_metadata(vec![( .create_logical_tables_metadata(vec![(
task.table_info.clone(), task.table_info.clone(),
TableRouteValue::logical(1024), TableRouteValue::logical(1024, vec![RegionId::new(8192, 1)]),
)]) )])
.await .await
.unwrap(); .unwrap();
@@ -252,7 +252,7 @@ async fn test_on_prepare_part_logical_tables_exist() {
.table_metadata_manager .table_metadata_manager
.create_logical_tables_metadata(vec![( .create_logical_tables_metadata(vec![(
task.table_info.clone(), task.table_info.clone(),
TableRouteValue::logical(1024), TableRouteValue::logical(1024, vec![RegionId::new(8192, 1)]),
)]) )])
.await .await
.unwrap(); .unwrap();
@@ -392,7 +392,7 @@ async fn test_on_create_metadata_part_logical_tables_exist() {
.table_metadata_manager .table_metadata_manager
.create_logical_tables_metadata(vec![( .create_logical_tables_metadata(vec![(
task.table_info.clone(), task.table_info.clone(),
TableRouteValue::logical(1024), TableRouteValue::logical(1024, vec![RegionId::new(8192, 1)]),
)]) )])
.await .await
.unwrap(); .unwrap();
@@ -496,7 +496,10 @@ async fn test_on_create_metadata_err() {
task.table_info.ident.table_id = 1025; task.table_info.ident.table_id = 1025;
ddl_context ddl_context
.table_metadata_manager .table_metadata_manager
.create_logical_tables_metadata(vec![(task.table_info, TableRouteValue::logical(512))]) .create_logical_tables_metadata(vec![(
task.table_info,
TableRouteValue::logical(512, vec![RegionId::new(1026, 1)]),
)])
.await .await
.unwrap(); .unwrap();
// Triggers procedure to create table metadata // Triggers procedure to create table metadata

View File

@@ -162,7 +162,7 @@ async fn test_on_prepare_table_exists_err() {
) )
.await .await
.unwrap(); .unwrap();
let mut procedure = CreateTableProcedure::new(task, ddl_context).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context);
let err = procedure.on_prepare().await.unwrap_err(); let err = procedure.on_prepare().await.unwrap_err();
assert_matches!(err, Error::TableAlreadyExists { .. }); assert_matches!(err, Error::TableAlreadyExists { .. });
assert_eq!(err.status_code(), StatusCode::TableAlreadyExists); assert_eq!(err.status_code(), StatusCode::TableAlreadyExists);
@@ -185,7 +185,7 @@ async fn test_on_prepare_with_create_if_table_exists() {
) )
.await .await
.unwrap(); .unwrap();
let mut procedure = CreateTableProcedure::new(task, ddl_context).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context);
let status = procedure.on_prepare().await.unwrap(); let status = procedure.on_prepare().await.unwrap();
assert_matches!(status, Status::Done { output: Some(..) }); assert_matches!(status, Status::Done { output: Some(..) });
let table_id = *status.downcast_output_ref::<u32>().unwrap(); let table_id = *status.downcast_output_ref::<u32>().unwrap();
@@ -198,7 +198,7 @@ async fn test_on_prepare_without_create_if_table_exists() {
let ddl_context = new_ddl_context(node_manager); let ddl_context = new_ddl_context(node_manager);
let mut task = test_create_table_task("foo"); let mut task = test_create_table_task("foo");
task.create_table.create_if_not_exists = true; task.create_table.create_if_not_exists = true;
let mut procedure = CreateTableProcedure::new(task, ddl_context).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context);
let status = procedure.on_prepare().await.unwrap(); let status = procedure.on_prepare().await.unwrap();
assert_matches!( assert_matches!(
status, status,
@@ -217,7 +217,7 @@ async fn test_on_datanode_create_regions_should_retry() {
let ddl_context = new_ddl_context(node_manager); let ddl_context = new_ddl_context(node_manager);
let task = test_create_table_task("foo"); let task = test_create_table_task("foo");
assert!(!task.create_table.create_if_not_exists); assert!(!task.create_table.create_if_not_exists);
let mut procedure = CreateTableProcedure::new(task, ddl_context).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context);
procedure.on_prepare().await.unwrap(); procedure.on_prepare().await.unwrap();
let ctx = ProcedureContext { let ctx = ProcedureContext {
procedure_id: ProcedureId::random(), procedure_id: ProcedureId::random(),
@@ -234,7 +234,7 @@ async fn test_on_datanode_create_regions_should_not_retry() {
let ddl_context = new_ddl_context(node_manager); let ddl_context = new_ddl_context(node_manager);
let task = test_create_table_task("foo"); let task = test_create_table_task("foo");
assert!(!task.create_table.create_if_not_exists); assert!(!task.create_table.create_if_not_exists);
let mut procedure = CreateTableProcedure::new(task, ddl_context).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context);
procedure.on_prepare().await.unwrap(); procedure.on_prepare().await.unwrap();
let ctx = ProcedureContext { let ctx = ProcedureContext {
procedure_id: ProcedureId::random(), procedure_id: ProcedureId::random(),
@@ -251,7 +251,7 @@ async fn test_on_create_metadata_error() {
let ddl_context = new_ddl_context(node_manager); let ddl_context = new_ddl_context(node_manager);
let task = test_create_table_task("foo"); let task = test_create_table_task("foo");
assert!(!task.create_table.create_if_not_exists); assert!(!task.create_table.create_if_not_exists);
let mut procedure = CreateTableProcedure::new(task.clone(), ddl_context.clone()).unwrap(); let mut procedure = CreateTableProcedure::new(task.clone(), ddl_context.clone());
procedure.on_prepare().await.unwrap(); procedure.on_prepare().await.unwrap();
let ctx = ProcedureContext { let ctx = ProcedureContext {
procedure_id: ProcedureId::random(), procedure_id: ProcedureId::random(),
@@ -284,7 +284,7 @@ async fn test_on_create_metadata() {
let ddl_context = new_ddl_context(node_manager); let ddl_context = new_ddl_context(node_manager);
let task = test_create_table_task("foo"); let task = test_create_table_task("foo");
assert!(!task.create_table.create_if_not_exists); assert!(!task.create_table.create_if_not_exists);
let mut procedure = CreateTableProcedure::new(task, ddl_context.clone()).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context.clone());
procedure.on_prepare().await.unwrap(); procedure.on_prepare().await.unwrap();
let ctx = ProcedureContext { let ctx = ProcedureContext {
procedure_id: ProcedureId::random(), procedure_id: ProcedureId::random(),
@@ -312,16 +312,16 @@ async fn test_memory_region_keeper_guard_dropped_on_procedure_done() {
let ddl_context = new_ddl_context_with_kv_backend(node_manager, kv_backend); let ddl_context = new_ddl_context_with_kv_backend(node_manager, kv_backend);
let task = test_create_table_task("foo"); let task = test_create_table_task("foo");
let mut procedure = CreateTableProcedure::new(task, ddl_context.clone()).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context.clone());
execute_procedure_until(&mut procedure, |p| { execute_procedure_until(&mut procedure, |p| {
p.data.state == CreateTableState::CreateMetadata p.creator.data.state == CreateTableState::CreateMetadata
}) })
.await; .await;
// Ensure that after running to the state `CreateMetadata`(just past `DatanodeCreateRegions`), // Ensure that after running to the state `CreateMetadata`(just past `DatanodeCreateRegions`),
// the opening regions should be recorded: // the opening regions should be recorded:
let guards = &procedure.opening_regions; let guards = &procedure.creator.opening_regions;
assert_eq!(guards.len(), 1); assert_eq!(guards.len(), 1);
let (datanode_id, region_id) = (0, RegionId::new(procedure.table_id(), 0)); let (datanode_id, region_id) = (0, RegionId::new(procedure.table_id(), 0));
assert_eq!(guards[0].info(), (datanode_id, region_id)); assert_eq!(guards[0].info(), (datanode_id, region_id));
@@ -334,7 +334,7 @@ async fn test_memory_region_keeper_guard_dropped_on_procedure_done() {
execute_procedure_until_done(&mut procedure).await; execute_procedure_until_done(&mut procedure).await;
// Ensure that when run to the end, the opening regions should be cleared: // Ensure that when run to the end, the opening regions should be cleared:
let guards = &procedure.opening_regions; let guards = &procedure.creator.opening_regions;
assert!(guards.is_empty()); assert!(guards.is_empty());
assert!( assert!(
!ddl_context !ddl_context

View File

@@ -259,7 +259,7 @@ async fn test_replace_table() {
{ {
// Create a `foo` table. // Create a `foo` table.
let task = test_create_table_task("foo"); let task = test_create_table_task("foo");
let mut procedure = CreateTableProcedure::new(task, ddl_context.clone()).unwrap(); let mut procedure = CreateTableProcedure::new(task, ddl_context.clone());
procedure.on_prepare().await.unwrap(); procedure.on_prepare().await.unwrap();
let ctx = ProcedureContext { let ctx = ProcedureContext {
procedure_id: ProcedureId::random(), procedure_id: ProcedureId::random(),

View File

@@ -231,7 +231,7 @@ impl DdlManager {
) -> Result<(ProcedureId, Option<Output>)> { ) -> Result<(ProcedureId, Option<Output>)> {
let context = self.create_context(); let context = self.create_context();
let procedure = CreateTableProcedure::new(create_table_task, context)?; let procedure = CreateTableProcedure::new(create_table_task, context);
let procedure_with_id = ProcedureWithId::with_random_id(Box::new(procedure)); let procedure_with_id = ProcedureWithId::with_random_id(Box::new(procedure));

View File

@@ -12,10 +12,27 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
use std::sync::OnceLock;
use std::time::Duration; use std::time::Duration;
pub const BASE_HEARTBEAT_INTERVAL: Duration = Duration::from_secs(3); use etcd_client::ConnectOptions;
/// Heartbeat interval time (is the basic unit of various time).
pub const HEARTBEAT_INTERVAL_MILLIS: u64 = 3000;
/// The frontend will also send heartbeats to Metasrv, sending an empty
/// heartbeat every HEARTBEAT_INTERVAL_MILLIS * 6 seconds.
pub const FRONTEND_HEARTBEAT_INTERVAL_MILLIS: u64 = HEARTBEAT_INTERVAL_MILLIS * 6;
/// The lease seconds of a region. It's set by 3 heartbeat intervals
/// (HEARTBEAT_INTERVAL_MILLIS × 3), plus some extra buffer (1 second).
pub const REGION_LEASE_SECS: u64 =
Duration::from_millis(HEARTBEAT_INTERVAL_MILLIS * 3).as_secs() + 1;
/// When creating table or region failover, a target node needs to be selected.
/// If the node's lease has expired, the `Selector` will not select it.
pub const DATANODE_LEASE_SECS: u64 = REGION_LEASE_SECS;
pub const FLOWNODE_LEASE_SECS: u64 = DATANODE_LEASE_SECS;
/// The lease seconds of metasrv leader. /// The lease seconds of metasrv leader.
pub const META_LEASE_SECS: u64 = 5; pub const META_LEASE_SECS: u64 = 5;
@@ -35,6 +52,14 @@ pub const HEARTBEAT_CHANNEL_KEEP_ALIVE_INTERVAL_SECS: Duration = Duration::from_
/// The keep-alive timeout of the heartbeat channel. /// The keep-alive timeout of the heartbeat channel.
pub const HEARTBEAT_CHANNEL_KEEP_ALIVE_TIMEOUT_SECS: Duration = Duration::from_secs(5); pub const HEARTBEAT_CHANNEL_KEEP_ALIVE_TIMEOUT_SECS: Duration = Duration::from_secs(5);
/// The default options for the etcd client.
pub fn default_etcd_client_options() -> ConnectOptions {
ConnectOptions::new()
.with_keep_alive_while_idle(true)
.with_keep_alive(Duration::from_secs(15), Duration::from_secs(5))
.with_connect_timeout(Duration::from_secs(10))
}
/// The default mailbox round-trip timeout. /// The default mailbox round-trip timeout.
pub const MAILBOX_RTT_SECS: u64 = 1; pub const MAILBOX_RTT_SECS: u64 = 1;
@@ -43,60 +68,3 @@ pub const TOPIC_STATS_REPORT_INTERVAL_SECS: u64 = 15;
/// The retention seconds of topic stats. /// The retention seconds of topic stats.
pub const TOPIC_STATS_RETENTION_SECS: u64 = TOPIC_STATS_REPORT_INTERVAL_SECS * 100; pub const TOPIC_STATS_RETENTION_SECS: u64 = TOPIC_STATS_REPORT_INTERVAL_SECS * 100;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// The distributed time constants.
pub struct DistributedTimeConstants {
pub heartbeat_interval: Duration,
pub frontend_heartbeat_interval: Duration,
pub region_lease: Duration,
pub datanode_lease: Duration,
pub flownode_lease: Duration,
}
/// The frontend heartbeat interval is 6 times of the base heartbeat interval.
pub fn frontend_heartbeat_interval(base_heartbeat_interval: Duration) -> Duration {
base_heartbeat_interval * 6
}
impl DistributedTimeConstants {
/// Create a new DistributedTimeConstants from the heartbeat interval.
pub fn from_heartbeat_interval(heartbeat_interval: Duration) -> Self {
let region_lease = heartbeat_interval * 3 + Duration::from_secs(1);
let datanode_lease = region_lease;
let flownode_lease = datanode_lease;
Self {
heartbeat_interval,
frontend_heartbeat_interval: frontend_heartbeat_interval(heartbeat_interval),
region_lease,
datanode_lease,
flownode_lease,
}
}
}
impl Default for DistributedTimeConstants {
fn default() -> Self {
Self::from_heartbeat_interval(BASE_HEARTBEAT_INTERVAL)
}
}
static DEFAULT_DISTRIBUTED_TIME_CONSTANTS: OnceLock<DistributedTimeConstants> = OnceLock::new();
/// Get the default distributed time constants.
pub fn default_distributed_time_constants() -> &'static DistributedTimeConstants {
DEFAULT_DISTRIBUTED_TIME_CONSTANTS.get_or_init(Default::default)
}
/// Initialize the default distributed time constants.
pub fn init_distributed_time_constants(base_heartbeat_interval: Duration) {
let distributed_time_constants =
DistributedTimeConstants::from_heartbeat_interval(base_heartbeat_interval);
DEFAULT_DISTRIBUTED_TIME_CONSTANTS
.set(distributed_time_constants)
.expect("Failed to set default distributed time constants");
common_telemetry::info!(
"Initialized default distributed time constants: {:#?}",
distributed_time_constants
);
}

View File

@@ -224,13 +224,6 @@ pub enum Error {
location: Location, location: Location,
}, },
#[snafu(display("Failed to find table repartition metadata for table id {}", table_id))]
TableRepartNotFound {
table_id: TableId,
#[snafu(implicit)]
location: Location,
},
#[snafu(display("Failed to decode protobuf"))] #[snafu(display("Failed to decode protobuf"))]
DecodeProto { DecodeProto {
#[snafu(implicit)] #[snafu(implicit)]
@@ -1098,7 +1091,6 @@ impl ErrorExt for Error {
| DecodeProto { .. } | DecodeProto { .. }
| BuildTableMeta { .. } | BuildTableMeta { .. }
| TableRouteNotFound { .. } | TableRouteNotFound { .. }
| TableRepartNotFound { .. }
| ConvertRawTableInfo { .. } | ConvertRawTableInfo { .. }
| RegionOperatingRace { .. } | RegionOperatingRace { .. }
| EncodeWalOptions { .. } | EncodeWalOptions { .. }

View File

@@ -514,65 +514,6 @@ impl Display for GcRegionsReply {
} }
} }
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct EnterStagingRegion {
pub region_id: RegionId,
pub partition_expr: String,
}
impl Display for EnterStagingRegion {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"EnterStagingRegion(region_id={}, partition_expr={})",
self.region_id, self.partition_expr
)
}
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RemapManifest {
pub region_id: RegionId,
/// Regions to remap manifests from.
pub input_regions: Vec<RegionId>,
/// For each old region, which new regions should receive its files
pub region_mapping: HashMap<RegionId, Vec<RegionId>>,
/// New partition expressions for the new regions.
pub new_partition_exprs: HashMap<RegionId, String>,
}
impl Display for RemapManifest {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"RemapManifest(region_id={}, input_regions={:?}, region_mapping={:?}, new_partition_exprs={:?})",
self.region_id, self.input_regions, self.region_mapping, self.new_partition_exprs
)
}
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ApplyStagingManifest {
/// The region ID to apply the staging manifest to.
pub region_id: RegionId,
/// The partition expression of the staging region.
pub partition_expr: String,
/// The region that stores the staging manifests in its staging blob storage.
pub central_region_id: RegionId,
/// The relative path to the staging manifest within the central region's staging blob storage.
pub manifest_path: String,
}
impl Display for ApplyStagingManifest {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"ApplyStagingManifest(region_id={}, partition_expr={}, central_region_id={}, manifest_path={})",
self.region_id, self.partition_expr, self.central_region_id, self.manifest_path
)
}
}
#[derive(Debug, Clone, Serialize, Deserialize, Display, PartialEq)] #[derive(Debug, Clone, Serialize, Deserialize, Display, PartialEq)]
pub enum Instruction { pub enum Instruction {
/// Opens regions. /// Opens regions.
@@ -600,12 +541,6 @@ pub enum Instruction {
GcRegions(GcRegions), GcRegions(GcRegions),
/// Temporary suspend serving reads or writes /// Temporary suspend serving reads or writes
Suspend, Suspend,
/// Makes regions enter staging state.
EnterStagingRegions(Vec<EnterStagingRegion>),
/// Remaps manifests for a region.
RemapManifest(RemapManifest),
/// Applies staging manifests for a region.
ApplyStagingManifests(Vec<ApplyStagingManifest>),
} }
impl Instruction { impl Instruction {
@@ -662,13 +597,6 @@ impl Instruction {
_ => None, _ => None,
} }
} }
pub fn into_enter_staging_regions(self) -> Option<Vec<EnterStagingRegion>> {
match self {
Self::EnterStagingRegions(enter_staging) => Some(enter_staging),
_ => None,
}
}
} }
/// The reply of [UpgradeRegion]. /// The reply of [UpgradeRegion].
@@ -762,70 +690,6 @@ where
}) })
} }
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct EnterStagingRegionReply {
pub region_id: RegionId,
/// Returns true if the region is under the new region rule.
pub ready: bool,
/// Indicates whether the region exists.
pub exists: bool,
/// Return error if any during the operation.
pub error: Option<String>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct EnterStagingRegionsReply {
pub replies: Vec<EnterStagingRegionReply>,
}
impl EnterStagingRegionsReply {
pub fn new(replies: Vec<EnterStagingRegionReply>) -> Self {
Self { replies }
}
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct RemapManifestReply {
/// Returns false if the region does not exist.
pub exists: bool,
/// A map from region IDs to their corresponding remapped manifest paths.
pub manifest_paths: HashMap<RegionId, String>,
/// Return error if any during the operation.
pub error: Option<String>,
}
impl Display for RemapManifestReply {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"RemapManifestReply(manifest_paths={:?}, error={:?})",
self.manifest_paths, self.error
)
}
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct ApplyStagingManifestsReply {
pub replies: Vec<ApplyStagingManifestReply>,
}
impl ApplyStagingManifestsReply {
pub fn new(replies: Vec<ApplyStagingManifestReply>) -> Self {
Self { replies }
}
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct ApplyStagingManifestReply {
pub region_id: RegionId,
/// Returns true if the region is ready to serve reads and writes.
pub ready: bool,
/// Indicates whether the region exists.
pub exists: bool,
/// Return error if any during the operation.
pub error: Option<String>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)] #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(tag = "type", rename_all = "snake_case")] #[serde(tag = "type", rename_all = "snake_case")]
pub enum InstructionReply { pub enum InstructionReply {
@@ -846,9 +710,6 @@ pub enum InstructionReply {
FlushRegions(FlushRegionReply), FlushRegions(FlushRegionReply),
GetFileRefs(GetFileRefsReply), GetFileRefs(GetFileRefsReply),
GcRegions(GcRegionsReply), GcRegions(GcRegionsReply),
EnterStagingRegions(EnterStagingRegionsReply),
RemapManifest(RemapManifestReply),
ApplyStagingManifests(ApplyStagingManifestsReply),
} }
impl Display for InstructionReply { impl Display for InstructionReply {
@@ -865,19 +726,6 @@ impl Display for InstructionReply {
Self::FlushRegions(reply) => write!(f, "InstructionReply::FlushRegions({})", reply), Self::FlushRegions(reply) => write!(f, "InstructionReply::FlushRegions({})", reply),
Self::GetFileRefs(reply) => write!(f, "InstructionReply::GetFileRefs({})", reply), Self::GetFileRefs(reply) => write!(f, "InstructionReply::GetFileRefs({})", reply),
Self::GcRegions(reply) => write!(f, "InstructionReply::GcRegion({})", reply), Self::GcRegions(reply) => write!(f, "InstructionReply::GcRegion({})", reply),
Self::EnterStagingRegions(reply) => {
write!(
f,
"InstructionReply::EnterStagingRegions({:?})",
reply.replies
)
}
Self::RemapManifest(reply) => write!(f, "InstructionReply::RemapManifest({})", reply),
Self::ApplyStagingManifests(reply) => write!(
f,
"InstructionReply::ApplyStagingManifests({:?})",
reply.replies
),
} }
} }
} }
@@ -918,34 +766,13 @@ impl InstructionReply {
_ => panic!("Expected FlushRegions reply"), _ => panic!("Expected FlushRegions reply"),
} }
} }
pub fn expect_enter_staging_regions_reply(self) -> Vec<EnterStagingRegionReply> {
match self {
Self::EnterStagingRegions(reply) => reply.replies,
_ => panic!("Expected EnterStagingRegion reply"),
}
}
pub fn expect_remap_manifest_reply(self) -> RemapManifestReply {
match self {
Self::RemapManifest(reply) => reply,
_ => panic!("Expected RemapManifest reply"),
}
}
pub fn expect_apply_staging_manifests_reply(self) -> Vec<ApplyStagingManifestReply> {
match self {
Self::ApplyStagingManifests(reply) => reply.replies,
_ => panic!("Expected ApplyStagingManifest reply"),
}
}
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use std::collections::HashSet; use std::collections::HashSet;
use store_api::storage::{FileId, FileRef}; use store_api::storage::FileId;
use super::*; use super::*;
@@ -1320,14 +1147,12 @@ mod tests {
let mut manifest = FileRefsManifest::default(); let mut manifest = FileRefsManifest::default();
let r0 = RegionId::new(1024, 1); let r0 = RegionId::new(1024, 1);
let r1 = RegionId::new(1024, 2); let r1 = RegionId::new(1024, 2);
manifest.file_refs.insert( manifest
r0, .file_refs
HashSet::from([FileRef::new(r0, FileId::random(), None)]), .insert(r0, HashSet::from([FileId::random()]));
); manifest
manifest.file_refs.insert( .file_refs
r1, .insert(r1, HashSet::from([FileId::random()]));
HashSet::from([FileRef::new(r1, FileId::random(), None)]),
);
manifest.manifest_version.insert(r0, 10); manifest.manifest_version.insert(r0, 10);
manifest.manifest_version.insert(r1, 20); manifest.manifest_version.insert(r1, 20);

View File

@@ -106,7 +106,6 @@ mod schema_metadata_manager;
pub mod schema_name; pub mod schema_name;
pub mod table_info; pub mod table_info;
pub mod table_name; pub mod table_name;
pub mod table_repart;
pub mod table_route; pub mod table_route;
#[cfg(any(test, feature = "testing"))] #[cfg(any(test, feature = "testing"))]
pub mod test_utils; pub mod test_utils;
@@ -157,7 +156,6 @@ use crate::DatanodeId;
use crate::error::{self, Result, SerdeJsonSnafu}; use crate::error::{self, Result, SerdeJsonSnafu};
use crate::key::flow::flow_state::FlowStateValue; use crate::key::flow::flow_state::FlowStateValue;
use crate::key::node_address::NodeAddressValue; use crate::key::node_address::NodeAddressValue;
use crate::key::table_repart::{TableRepartKey, TableRepartManager};
use crate::key::table_route::TableRouteKey; use crate::key::table_route::TableRouteKey;
use crate::key::topic_region::TopicRegionValue; use crate::key::topic_region::TopicRegionValue;
use crate::key::txn_helper::TxnOpGetResponseSet; use crate::key::txn_helper::TxnOpGetResponseSet;
@@ -180,7 +178,6 @@ pub const TABLE_NAME_KEY_PREFIX: &str = "__table_name";
pub const CATALOG_NAME_KEY_PREFIX: &str = "__catalog_name"; pub const CATALOG_NAME_KEY_PREFIX: &str = "__catalog_name";
pub const SCHEMA_NAME_KEY_PREFIX: &str = "__schema_name"; pub const SCHEMA_NAME_KEY_PREFIX: &str = "__schema_name";
pub const TABLE_ROUTE_PREFIX: &str = "__table_route"; pub const TABLE_ROUTE_PREFIX: &str = "__table_route";
pub const TABLE_REPART_PREFIX: &str = "__table_repart";
pub const NODE_ADDRESS_PREFIX: &str = "__node_address"; pub const NODE_ADDRESS_PREFIX: &str = "__node_address";
pub const KAFKA_TOPIC_KEY_PREFIX: &str = "__topic_name/kafka"; pub const KAFKA_TOPIC_KEY_PREFIX: &str = "__topic_name/kafka";
// The legacy topic key prefix is used to store the topic name in previous versions. // The legacy topic key prefix is used to store the topic name in previous versions.
@@ -291,11 +288,6 @@ lazy_static! {
Regex::new(&format!("^{TABLE_ROUTE_PREFIX}/([0-9]+)$")).unwrap(); Regex::new(&format!("^{TABLE_ROUTE_PREFIX}/([0-9]+)$")).unwrap();
} }
lazy_static! {
pub(crate) static ref TABLE_REPART_KEY_PATTERN: Regex =
Regex::new(&format!("^{TABLE_REPART_PREFIX}/([0-9]+)$")).unwrap();
}
lazy_static! { lazy_static! {
static ref DATANODE_TABLE_KEY_PATTERN: Regex = static ref DATANODE_TABLE_KEY_PATTERN: Regex =
Regex::new(&format!("^{DATANODE_TABLE_KEY_PREFIX}/([0-9]+)/([0-9]+)$")).unwrap(); Regex::new(&format!("^{DATANODE_TABLE_KEY_PREFIX}/([0-9]+)/([0-9]+)$")).unwrap();
@@ -394,7 +386,6 @@ pub struct TableMetadataManager {
catalog_manager: CatalogManager, catalog_manager: CatalogManager,
schema_manager: SchemaManager, schema_manager: SchemaManager,
table_route_manager: TableRouteManager, table_route_manager: TableRouteManager,
table_repart_manager: TableRepartManager,
tombstone_manager: TombstoneManager, tombstone_manager: TombstoneManager,
topic_name_manager: TopicNameManager, topic_name_manager: TopicNameManager,
topic_region_manager: TopicRegionManager, topic_region_manager: TopicRegionManager,
@@ -547,7 +538,6 @@ impl TableMetadataManager {
catalog_manager: CatalogManager::new(kv_backend.clone()), catalog_manager: CatalogManager::new(kv_backend.clone()),
schema_manager: SchemaManager::new(kv_backend.clone()), schema_manager: SchemaManager::new(kv_backend.clone()),
table_route_manager: TableRouteManager::new(kv_backend.clone()), table_route_manager: TableRouteManager::new(kv_backend.clone()),
table_repart_manager: TableRepartManager::new(kv_backend.clone()),
tombstone_manager: TombstoneManager::new(kv_backend.clone()), tombstone_manager: TombstoneManager::new(kv_backend.clone()),
topic_name_manager: TopicNameManager::new(kv_backend.clone()), topic_name_manager: TopicNameManager::new(kv_backend.clone()),
topic_region_manager: TopicRegionManager::new(kv_backend.clone()), topic_region_manager: TopicRegionManager::new(kv_backend.clone()),
@@ -568,7 +558,6 @@ impl TableMetadataManager {
catalog_manager: CatalogManager::new(kv_backend.clone()), catalog_manager: CatalogManager::new(kv_backend.clone()),
schema_manager: SchemaManager::new(kv_backend.clone()), schema_manager: SchemaManager::new(kv_backend.clone()),
table_route_manager: TableRouteManager::new(kv_backend.clone()), table_route_manager: TableRouteManager::new(kv_backend.clone()),
table_repart_manager: TableRepartManager::new(kv_backend.clone()),
tombstone_manager: TombstoneManager::new_with_prefix( tombstone_manager: TombstoneManager::new_with_prefix(
kv_backend.clone(), kv_backend.clone(),
tombstone_prefix, tombstone_prefix,
@@ -627,10 +616,6 @@ impl TableMetadataManager {
&self.table_route_manager &self.table_route_manager
} }
pub fn table_repart_manager(&self) -> &TableRepartManager {
&self.table_repart_manager
}
pub fn topic_name_manager(&self) -> &TopicNameManager { pub fn topic_name_manager(&self) -> &TopicNameManager {
&self.topic_name_manager &self.topic_name_manager
} }
@@ -747,10 +732,12 @@ impl TableMetadataManager {
/// The caller MUST ensure it has the exclusive access to `TableNameKey`. /// The caller MUST ensure it has the exclusive access to `TableNameKey`.
pub async fn create_table_metadata( pub async fn create_table_metadata(
&self, &self,
table_info: RawTableInfo, mut table_info: RawTableInfo,
table_route_value: TableRouteValue, table_route_value: TableRouteValue,
region_wal_options: HashMap<RegionNumber, String>, region_wal_options: HashMap<RegionNumber, String>,
) -> Result<()> { ) -> Result<()> {
let region_numbers = table_route_value.region_numbers();
table_info.meta.region_numbers = region_numbers;
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
let engine = table_info.meta.engine.clone(); let engine = table_info.meta.engine.clone();
@@ -849,7 +836,8 @@ impl TableMetadataManager {
on_create_table_route_failure: F2, on_create_table_route_failure: F2,
} }
let mut on_failures = Vec::with_capacity(len); let mut on_failures = Vec::with_capacity(len);
for (table_info, table_route_value) in tables_data { for (mut table_info, table_route_value) in tables_data {
table_info.meta.region_numbers = table_route_value.region_numbers();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
// Creates table name. // Creates table name.
@@ -935,7 +923,6 @@ impl TableMetadataManager {
); );
let table_info_key = TableInfoKey::new(table_id); let table_info_key = TableInfoKey::new(table_id);
let table_route_key = TableRouteKey::new(table_id); let table_route_key = TableRouteKey::new(table_id);
let table_repart_key = TableRepartKey::new(table_id);
let datanode_table_keys = datanode_ids let datanode_table_keys = datanode_ids
.into_iter() .into_iter()
.map(|datanode_id| DatanodeTableKey::new(datanode_id, table_id)) .map(|datanode_id| DatanodeTableKey::new(datanode_id, table_id))
@@ -950,7 +937,6 @@ impl TableMetadataManager {
keys.push(table_name.to_bytes()); keys.push(table_name.to_bytes());
keys.push(table_info_key.to_bytes()); keys.push(table_info_key.to_bytes());
keys.push(table_route_key.to_bytes()); keys.push(table_route_key.to_bytes());
keys.push(table_repart_key.to_bytes());
for key in &datanode_table_keys { for key in &datanode_table_keys {
keys.push(key.to_bytes()); keys.push(key.to_bytes());
} }
@@ -1540,8 +1526,8 @@ mod tests {
} }
} }
fn new_test_table_info() -> TableInfo { fn new_test_table_info(region_numbers: impl Iterator<Item = u32>) -> TableInfo {
test_utils::new_test_table_info(10) test_utils::new_test_table_info(10, region_numbers)
} }
fn new_test_table_names() -> HashSet<TableName> { fn new_test_table_names() -> HashSet<TableName> {
@@ -1599,7 +1585,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv.clone()); let table_metadata_manager = TableMetadataManager::new(mem_kv.clone());
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = &vec![region_route.clone()]; let region_routes = &vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let wal_allocator = WalOptionsAllocator::RaftEngine; let wal_allocator = WalOptionsAllocator::RaftEngine;
let regions = (0..16).collect(); let regions = (0..16).collect();
let region_wal_options = let region_wal_options =
@@ -1626,7 +1613,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = &vec![region_route.clone()]; let region_routes = &vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let region_wal_options = create_mock_region_wal_options() let region_wal_options = create_mock_region_wal_options()
.into_iter() .into_iter()
.map(|(k, v)| (k, serde_json::to_string(&v).unwrap())) .map(|(k, v)| (k, serde_json::to_string(&v).unwrap()))
@@ -1708,7 +1696,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = vec![region_route.clone()]; let region_routes = vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
let table_route_value = TableRouteValue::physical(region_routes.clone()); let table_route_value = TableRouteValue::physical(region_routes.clone());
@@ -1773,6 +1762,7 @@ mod tests {
let table_info: RawTableInfo = test_utils::new_test_table_info_with_name( let table_info: RawTableInfo = test_utils::new_test_table_info_with_name(
table_id, table_id,
&format!("my_table_{}", table_id), &format!("my_table_{}", table_id),
region_routes.iter().map(|r| r.region.id.region_number()),
) )
.into(); .into();
let table_route_value = TableRouteValue::physical(region_routes.clone()); let table_route_value = TableRouteValue::physical(region_routes.clone());
@@ -1793,7 +1783,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = &vec![region_route.clone()]; let region_routes = &vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
let datanode_id = 2; let datanode_id = 2;
let region_wal_options = create_mock_region_wal_options(); let region_wal_options = create_mock_region_wal_options();
@@ -1899,7 +1890,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = vec![region_route.clone()]; let region_routes = vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
// creates metadata. // creates metadata.
create_physical_table_metadata( create_physical_table_metadata(
@@ -1975,7 +1967,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = vec![region_route.clone()]; let region_routes = vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
// creates metadata. // creates metadata.
create_physical_table_metadata( create_physical_table_metadata(
@@ -2060,7 +2053,8 @@ mod tests {
leader_down_since: None, leader_down_since: None,
}, },
]; ];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
let current_table_route_value = DeserializedValueWithBytes::from_inner( let current_table_route_value = DeserializedValueWithBytes::from_inner(
TableRouteValue::physical(region_routes.clone()), TableRouteValue::physical(region_routes.clone()),
@@ -2142,7 +2136,8 @@ mod tests {
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let region_route = new_test_region_route(); let region_route = new_test_region_route();
let region_routes = vec![region_route.clone()]; let region_routes = vec![region_route.clone()];
let table_info: RawTableInfo = new_test_table_info().into(); let table_info: RawTableInfo =
new_test_table_info(region_routes.iter().map(|r| r.region.id.region_number())).into();
let table_id = table_info.ident.table_id; let table_id = table_info.ident.table_id;
let engine = table_info.meta.engine.as_str(); let engine = table_info.meta.engine.as_str();
let region_storage_path = let region_storage_path =
@@ -2396,7 +2391,7 @@ mod tests {
let mem_kv = Arc::new(MemoryKvBackend::default()); let mem_kv = Arc::new(MemoryKvBackend::default());
let table_metadata_manager = TableMetadataManager::new(mem_kv); let table_metadata_manager = TableMetadataManager::new(mem_kv);
let view_info: RawTableInfo = new_test_table_info().into(); let view_info: RawTableInfo = new_test_table_info(Vec::<u32>::new().into_iter()).into();
let view_id = view_info.ident.table_id; let view_id = view_info.ident.table_id;

View File

@@ -338,6 +338,7 @@ mod tests {
next_column_id: 3, next_column_id: 3,
value_indices: vec![2, 3], value_indices: vec![2, 3],
options: Default::default(), options: Default::default(),
region_numbers: vec![1],
partition_key_indices: vec![], partition_key_indices: vec![],
column_ids: vec![], column_ids: vec![],
}; };

View File

@@ -1,856 +0,0 @@
// Copyright 2023 Greptime Team
//
// Licensed 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.
use std::collections::{BTreeMap, BTreeSet, HashMap};
use std::fmt::Display;
use serde::{Deserialize, Serialize};
use snafu::{OptionExt as _, ResultExt, ensure};
use store_api::storage::RegionId;
use table::metadata::TableId;
use crate::error::{InvalidMetadataSnafu, Result, SerdeJsonSnafu};
use crate::key::txn_helper::TxnOpGetResponseSet;
use crate::key::{
DeserializedValueWithBytes, MetadataKey, MetadataValue, TABLE_REPART_KEY_PATTERN,
TABLE_REPART_PREFIX,
};
use crate::kv_backend::KvBackendRef;
use crate::kv_backend::txn::Txn;
use crate::rpc::store::BatchGetRequest;
/// The key stores table repartition metadata.
/// Specifically, it records the relation between source and destination regions after a repartition operation is completed.
/// This is distinct from the initial partitioning scheme of the table.
/// For example, after repartition, a destination region may still hold files from a source region; this mapping should be updated once repartition is done.
/// The GC scheduler uses this information to clean up those files (and removes this mapping if all files from the source region are cleaned).
///
/// The layout: `__table_repart/{table_id}`.
#[derive(Debug, PartialEq)]
pub struct TableRepartKey {
/// The unique identifier of the table whose re-partition information is stored in this key.
pub table_id: TableId,
}
impl TableRepartKey {
pub fn new(table_id: TableId) -> Self {
Self { table_id }
}
/// Returns the range prefix of the table repartition key.
pub fn range_prefix() -> Vec<u8> {
format!("{}/", TABLE_REPART_PREFIX).into_bytes()
}
}
impl MetadataKey<'_, TableRepartKey> for TableRepartKey {
fn to_bytes(&self) -> Vec<u8> {
self.to_string().into_bytes()
}
fn from_bytes(bytes: &[u8]) -> Result<TableRepartKey> {
let key = std::str::from_utf8(bytes).map_err(|e| {
InvalidMetadataSnafu {
err_msg: format!(
"TableRepartKey '{}' is not a valid UTF8 string: {e}",
String::from_utf8_lossy(bytes)
),
}
.build()
})?;
let captures = TABLE_REPART_KEY_PATTERN
.captures(key)
.context(InvalidMetadataSnafu {
err_msg: format!("Invalid TableRepartKey '{key}'"),
})?;
// Safety: pass the regex check above
let table_id = captures[1].parse::<TableId>().unwrap();
Ok(TableRepartKey { table_id })
}
}
impl Display for TableRepartKey {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}/{}", TABLE_REPART_PREFIX, self.table_id)
}
}
#[derive(Debug, PartialEq, Serialize, Deserialize, Clone, Default)]
pub struct TableRepartValue {
/// A mapping from source region IDs to sets of destination region IDs after repartition.
///
/// Each key in the map is a `RegionId` representing a source region that has been repartitioned.
/// The corresponding value is a `BTreeSet<RegionId>` containing the IDs of destination regions
/// that currently hold files originally from the source region. This mapping is updated after
/// repartition and is used by the GC scheduler to track and clean up files that have been moved.
pub src_to_dst: BTreeMap<RegionId, BTreeSet<RegionId>>,
}
impl TableRepartValue {
/// Creates a new TableRepartValue with an empty src_to_dst map.
pub fn new() -> Self {
Default::default()
}
/// Update mapping from src region to dst regions. Should be called once repartition is done.
///
/// If `dst` is empty, this method does nothing.
pub fn update_mappings(&mut self, src: RegionId, dst: &[RegionId]) {
if dst.is_empty() {
return;
}
self.src_to_dst.entry(src).or_default().extend(dst);
}
/// Remove mappings from src region to dst regions. Should be called once files from src region are cleaned up in dst regions.
pub fn remove_mappings(&mut self, src: RegionId, dsts: &[RegionId]) {
if let Some(dst_set) = self.src_to_dst.get_mut(&src) {
for dst in dsts {
dst_set.remove(dst);
}
if dst_set.is_empty() {
self.src_to_dst.remove(&src);
}
}
}
}
impl MetadataValue for TableRepartValue {
fn try_from_raw_value(raw_value: &[u8]) -> Result<Self> {
serde_json::from_slice::<TableRepartValue>(raw_value).context(SerdeJsonSnafu)
}
fn try_as_raw_value(&self) -> Result<Vec<u8>> {
serde_json::to_vec(self).context(SerdeJsonSnafu)
}
}
pub type TableRepartValueDecodeResult =
Result<Option<DeserializedValueWithBytes<TableRepartValue>>>;
pub struct TableRepartManager {
kv_backend: KvBackendRef,
}
impl TableRepartManager {
pub fn new(kv_backend: KvBackendRef) -> Self {
Self { kv_backend }
}
/// Builds a create table repart transaction,
/// it expected the `__table_repart/{table_id}` wasn't occupied.
pub fn build_create_txn(
&self,
table_id: TableId,
table_repart_value: &TableRepartValue,
) -> Result<(
Txn,
impl FnOnce(&mut TxnOpGetResponseSet) -> TableRepartValueDecodeResult + use<>,
)> {
let key = TableRepartKey::new(table_id);
let raw_key = key.to_bytes();
let txn = Txn::put_if_not_exists(raw_key.clone(), table_repart_value.try_as_raw_value()?);
Ok((
txn,
TxnOpGetResponseSet::decode_with(TxnOpGetResponseSet::filter(raw_key)),
))
}
/// Builds a update table repart transaction,
/// it expected the remote value equals the `current_table_repart_value`.
/// It retrieves the latest value if the comparing failed.
pub fn build_update_txn(
&self,
table_id: TableId,
current_table_repart_value: &DeserializedValueWithBytes<TableRepartValue>,
new_table_repart_value: &TableRepartValue,
) -> Result<(
Txn,
impl FnOnce(&mut TxnOpGetResponseSet) -> TableRepartValueDecodeResult + use<>,
)> {
let key = TableRepartKey::new(table_id);
let raw_key = key.to_bytes();
let raw_value = current_table_repart_value.get_raw_bytes();
let new_raw_value: Vec<u8> = new_table_repart_value.try_as_raw_value()?;
let txn = Txn::compare_and_put(raw_key.clone(), raw_value, new_raw_value);
Ok((
txn,
TxnOpGetResponseSet::decode_with(TxnOpGetResponseSet::filter(raw_key)),
))
}
/// Returns the [`TableRepartValue`].
pub async fn get(&self, table_id: TableId) -> Result<Option<TableRepartValue>> {
self.get_inner(table_id).await
}
async fn get_inner(&self, table_id: TableId) -> Result<Option<TableRepartValue>> {
let key = TableRepartKey::new(table_id);
self.kv_backend
.get(&key.to_bytes())
.await?
.map(|kv| TableRepartValue::try_from_raw_value(&kv.value))
.transpose()
}
/// Returns the [`TableRepartValue`] wrapped with [`DeserializedValueWithBytes`].
pub async fn get_with_raw_bytes(
&self,
table_id: TableId,
) -> Result<Option<DeserializedValueWithBytes<TableRepartValue>>> {
self.get_with_raw_bytes_inner(table_id).await
}
async fn get_with_raw_bytes_inner(
&self,
table_id: TableId,
) -> Result<Option<DeserializedValueWithBytes<TableRepartValue>>> {
let key = TableRepartKey::new(table_id);
self.kv_backend
.get(&key.to_bytes())
.await?
.map(|kv| DeserializedValueWithBytes::from_inner_slice(&kv.value))
.transpose()
}
/// Returns batch of [`TableRepartValue`] that respects the order of `table_ids`.
pub async fn batch_get(&self, table_ids: &[TableId]) -> Result<Vec<Option<TableRepartValue>>> {
let raw_table_reparts = self.batch_get_inner(table_ids).await?;
Ok(raw_table_reparts
.into_iter()
.map(|v| v.map(|x| x.inner))
.collect())
}
/// Returns batch of [`TableRepartValue`] wrapped with [`DeserializedValueWithBytes`].
pub async fn batch_get_with_raw_bytes(
&self,
table_ids: &[TableId],
) -> Result<Vec<Option<DeserializedValueWithBytes<TableRepartValue>>>> {
self.batch_get_inner(table_ids).await
}
async fn batch_get_inner(
&self,
table_ids: &[TableId],
) -> Result<Vec<Option<DeserializedValueWithBytes<TableRepartValue>>>> {
let keys = table_ids
.iter()
.map(|id| TableRepartKey::new(*id).to_bytes())
.collect::<Vec<_>>();
let resp = self
.kv_backend
.batch_get(BatchGetRequest { keys: keys.clone() })
.await?;
let kvs = resp
.kvs
.into_iter()
.map(|kv| (kv.key, kv.value))
.collect::<HashMap<_, _>>();
keys.into_iter()
.map(|key| {
if let Some(value) = kvs.get(&key) {
Ok(Some(DeserializedValueWithBytes::from_inner_slice(value)?))
} else {
Ok(None)
}
})
.collect()
}
/// Updates mappings from src region to dst regions.
/// Should be called once repartition is done.
pub async fn update_mappings(&self, src: RegionId, dst: &[RegionId]) -> Result<()> {
let table_id = src.table_id();
// Get current table repart with raw bytes for CAS operation
let current_table_repart = self
.get_with_raw_bytes(table_id)
.await?
.context(crate::error::TableRepartNotFoundSnafu { table_id })?;
// Clone the current repart value and update mappings
let mut new_table_repart_value = current_table_repart.inner.clone();
new_table_repart_value.update_mappings(src, dst);
// Execute atomic update
let (txn, _) =
self.build_update_txn(table_id, &current_table_repart, &new_table_repart_value)?;
let result = self.kv_backend.txn(txn).await?;
ensure!(
result.succeeded,
crate::error::MetadataCorruptionSnafu {
err_msg: format!(
"Failed to update mappings for table {}: CAS operation failed",
table_id
),
}
);
Ok(())
}
/// Removes mappings from src region to dst regions.
/// Should be called once files from src region are cleaned up in dst regions.
pub async fn remove_mappings(&self, src: RegionId, dsts: &[RegionId]) -> Result<()> {
let table_id = src.table_id();
// Get current table repart with raw bytes for CAS operation
let current_table_repart = self
.get_with_raw_bytes(table_id)
.await?
.context(crate::error::TableRepartNotFoundSnafu { table_id })?;
// Clone the current repart value and remove mappings
let mut new_table_repart_value = current_table_repart.inner.clone();
new_table_repart_value.remove_mappings(src, dsts);
// Execute atomic update
let (txn, _) =
self.build_update_txn(table_id, &current_table_repart, &new_table_repart_value)?;
let result = self.kv_backend.txn(txn).await?;
ensure!(
result.succeeded,
crate::error::MetadataCorruptionSnafu {
err_msg: format!(
"Failed to remove mappings for table {}: CAS operation failed",
table_id
),
}
);
Ok(())
}
/// Returns the destination regions for a given source region.
pub async fn get_dst_regions(
&self,
src_region: RegionId,
) -> Result<Option<BTreeSet<RegionId>>> {
let table_id = src_region.table_id();
let table_repart = self.get(table_id).await?;
Ok(table_repart.and_then(|repart| repart.src_to_dst.get(&src_region).cloned()))
}
}
#[cfg(test)]
mod tests {
use std::collections::BTreeMap;
use std::sync::Arc;
use super::*;
use crate::kv_backend::TxnService;
use crate::kv_backend::memory::MemoryKvBackend;
#[test]
fn test_table_repart_key_serialization() {
let key = TableRepartKey::new(42);
let raw_key = key.to_bytes();
assert_eq!(raw_key, b"__table_repart/42");
}
#[test]
fn test_table_repart_key_deserialization() {
let expected = TableRepartKey::new(42);
let key = TableRepartKey::from_bytes(b"__table_repart/42").unwrap();
assert_eq!(key, expected);
}
#[test]
fn test_table_repart_key_deserialization_invalid_utf8() {
let result = TableRepartKey::from_bytes(b"__table_repart/\xff");
assert!(result.is_err());
assert!(
result
.unwrap_err()
.to_string()
.contains("not a valid UTF8 string")
);
}
#[test]
fn test_table_repart_key_deserialization_invalid_format() {
let result = TableRepartKey::from_bytes(b"invalid_key_format");
assert!(result.is_err());
assert!(
result
.unwrap_err()
.to_string()
.contains("Invalid TableRepartKey")
);
}
#[test]
fn test_table_repart_value_serialization_deserialization() {
let mut src_to_dst = BTreeMap::new();
let src_region = RegionId::new(1, 1);
let dst_regions = vec![RegionId::new(1, 2), RegionId::new(1, 3)];
src_to_dst.insert(src_region, dst_regions.into_iter().collect());
let value = TableRepartValue { src_to_dst };
let serialized = value.try_as_raw_value().unwrap();
let deserialized = TableRepartValue::try_from_raw_value(&serialized).unwrap();
assert_eq!(value, deserialized);
}
#[test]
fn test_table_repart_value_update_mappings_new_src() {
let mut value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let src = RegionId::new(1, 1);
let dst = vec![RegionId::new(1, 2), RegionId::new(1, 3)];
value.update_mappings(src, &dst);
assert_eq!(value.src_to_dst.len(), 1);
assert!(value.src_to_dst.contains_key(&src));
assert_eq!(value.src_to_dst.get(&src).unwrap().len(), 2);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 2))
);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 3))
);
}
#[test]
fn test_table_repart_value_update_mappings_existing_src() {
let mut value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let src = RegionId::new(1, 1);
let initial_dst = vec![RegionId::new(1, 2)];
let additional_dst = vec![RegionId::new(1, 3), RegionId::new(1, 4)];
// Initial mapping
value.update_mappings(src, &initial_dst);
// Update with additional destinations
value.update_mappings(src, &additional_dst);
assert_eq!(value.src_to_dst.len(), 1);
assert_eq!(value.src_to_dst.get(&src).unwrap().len(), 3);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 2))
);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 3))
);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 4))
);
}
#[test]
fn test_table_repart_value_remove_mappings_existing() {
let mut value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let src = RegionId::new(1, 1);
let dst_regions = vec![
RegionId::new(1, 2),
RegionId::new(1, 3),
RegionId::new(1, 4),
];
value.update_mappings(src, &dst_regions);
// Remove some mappings
let to_remove = vec![RegionId::new(1, 2), RegionId::new(1, 3)];
value.remove_mappings(src, &to_remove);
assert_eq!(value.src_to_dst.len(), 1);
assert_eq!(value.src_to_dst.get(&src).unwrap().len(), 1);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 4))
);
}
#[test]
fn test_table_repart_value_remove_mappings_all() {
let mut value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let src = RegionId::new(1, 1);
let dst_regions = vec![RegionId::new(1, 2), RegionId::new(1, 3)];
value.update_mappings(src, &dst_regions);
// Remove all mappings
value.remove_mappings(src, &dst_regions);
assert_eq!(value.src_to_dst.len(), 0);
}
#[test]
fn test_table_repart_value_remove_mappings_nonexistent() {
let mut value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let src = RegionId::new(1, 1);
let dst_regions = vec![RegionId::new(1, 2)];
value.update_mappings(src, &dst_regions);
// Try to remove non-existent mappings
let nonexistent_dst = vec![RegionId::new(1, 3), RegionId::new(1, 4)];
value.remove_mappings(src, &nonexistent_dst);
// Should remain unchanged
assert_eq!(value.src_to_dst.len(), 1);
assert_eq!(value.src_to_dst.get(&src).unwrap().len(), 1);
assert!(
value
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1, 2))
);
}
#[test]
fn test_table_repart_value_remove_mappings_nonexistent_src() {
let mut value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let src = RegionId::new(1, 1);
let dst_regions = vec![RegionId::new(1, 2)];
// Try to remove mappings for non-existent source
value.remove_mappings(src, &dst_regions);
// Should remain empty
assert_eq!(value.src_to_dst.len(), 0);
}
#[tokio::test]
async fn test_table_repart_manager_get_empty() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv);
let result = manager.get(1024).await.unwrap();
assert!(result.is_none());
}
#[tokio::test]
async fn test_table_repart_manager_get_with_raw_bytes_empty() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv);
let result = manager.get_with_raw_bytes(1024).await.unwrap();
assert!(result.is_none());
}
#[tokio::test]
async fn test_table_repart_manager_create_and_get() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
let mut src_to_dst = BTreeMap::new();
let src_region = RegionId::new(1, 1);
let dst_regions = vec![RegionId::new(1, 2), RegionId::new(1, 3)];
src_to_dst.insert(src_region, dst_regions.into_iter().collect());
let value = TableRepartValue { src_to_dst };
// Create the table repart
let (txn, _) = manager.build_create_txn(1024, &value).unwrap();
let result = kv.txn(txn).await.unwrap();
assert!(result.succeeded);
// Get the table repart
let retrieved = manager.get(1024).await.unwrap().unwrap();
assert_eq!(retrieved, value);
}
#[tokio::test]
async fn test_table_repart_manager_update_txn() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
let initial_value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
// Create initial table repart
let (create_txn, _) = manager.build_create_txn(1024, &initial_value).unwrap();
let result = kv.txn(create_txn).await.unwrap();
assert!(result.succeeded);
// Get current value with raw bytes
let current_value = manager.get_with_raw_bytes(1024).await.unwrap().unwrap();
// Create updated value
let mut updated_src_to_dst = BTreeMap::new();
let src_region = RegionId::new(1, 1);
let dst_regions = vec![RegionId::new(1, 2)];
updated_src_to_dst.insert(src_region, dst_regions.into_iter().collect());
let updated_value = TableRepartValue {
src_to_dst: updated_src_to_dst,
};
// Build update transaction
let (update_txn, _) = manager
.build_update_txn(1024, &current_value, &updated_value)
.unwrap();
let result = kv.txn(update_txn).await.unwrap();
assert!(result.succeeded);
// Verify update
let retrieved = manager.get(1024).await.unwrap().unwrap();
assert_eq!(retrieved, updated_value);
}
#[tokio::test]
async fn test_table_repart_manager_batch_get() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
// Create multiple table reparts
let table_reparts = vec![
(
1024,
TableRepartValue {
src_to_dst: {
let mut map = BTreeMap::new();
map.insert(
RegionId::new(1, 1),
vec![RegionId::new(1, 2)].into_iter().collect(),
);
map
},
},
),
(
1025,
TableRepartValue {
src_to_dst: {
let mut map = BTreeMap::new();
map.insert(
RegionId::new(2, 1),
vec![RegionId::new(2, 2), RegionId::new(2, 3)]
.into_iter()
.collect(),
);
map
},
},
),
];
for (table_id, value) in &table_reparts {
let (txn, _) = manager.build_create_txn(*table_id, value).unwrap();
let result = kv.txn(txn).await.unwrap();
assert!(result.succeeded);
}
// Batch get
let results = manager.batch_get(&[1024, 1025, 1026]).await.unwrap();
assert_eq!(results.len(), 3);
assert_eq!(results[0].as_ref().unwrap(), &table_reparts[0].1);
assert_eq!(results[1].as_ref().unwrap(), &table_reparts[1].1);
assert!(results[2].is_none());
}
#[tokio::test]
async fn test_table_repart_manager_update_mappings() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
// Create initial table repart
let initial_value = TableRepartValue {
src_to_dst: BTreeMap::new(),
};
let (txn, _) = manager.build_create_txn(1024, &initial_value).unwrap();
let result = kv.txn(txn).await.unwrap();
assert!(result.succeeded);
// Update mappings
let src = RegionId::new(1024, 1);
let dst = vec![RegionId::new(1024, 2), RegionId::new(1024, 3)];
manager.update_mappings(src, &dst).await.unwrap();
// Verify update
let retrieved = manager.get(1024).await.unwrap().unwrap();
assert_eq!(retrieved.src_to_dst.len(), 1);
assert!(retrieved.src_to_dst.contains_key(&src));
assert_eq!(retrieved.src_to_dst.get(&src).unwrap().len(), 2);
}
#[tokio::test]
async fn test_table_repart_manager_remove_mappings() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
// Create initial table repart with mappings
let mut initial_src_to_dst = BTreeMap::new();
let src = RegionId::new(1024, 1);
let dst_regions = vec![
RegionId::new(1024, 2),
RegionId::new(1024, 3),
RegionId::new(1024, 4),
];
initial_src_to_dst.insert(src, dst_regions.into_iter().collect());
let initial_value = TableRepartValue {
src_to_dst: initial_src_to_dst,
};
let (txn, _) = manager.build_create_txn(1024, &initial_value).unwrap();
let result = kv.txn(txn).await.unwrap();
assert!(result.succeeded);
// Remove some mappings
let to_remove = vec![RegionId::new(1024, 2), RegionId::new(1024, 3)];
manager.remove_mappings(src, &to_remove).await.unwrap();
// Verify removal
let retrieved = manager.get(1024).await.unwrap().unwrap();
assert_eq!(retrieved.src_to_dst.len(), 1);
assert_eq!(retrieved.src_to_dst.get(&src).unwrap().len(), 1);
assert!(
retrieved
.src_to_dst
.get(&src)
.unwrap()
.contains(&RegionId::new(1024, 4))
);
}
#[tokio::test]
async fn test_table_repart_manager_get_dst_regions() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
// Create initial table repart with mappings
let mut initial_src_to_dst = BTreeMap::new();
let src = RegionId::new(1024, 1);
let dst_regions = vec![RegionId::new(1024, 2), RegionId::new(1024, 3)];
initial_src_to_dst.insert(src, dst_regions.into_iter().collect());
let initial_value = TableRepartValue {
src_to_dst: initial_src_to_dst,
};
let (txn, _) = manager.build_create_txn(1024, &initial_value).unwrap();
let result = kv.txn(txn).await.unwrap();
assert!(result.succeeded);
// Get destination regions
let dst_regions = manager.get_dst_regions(src).await.unwrap();
assert!(dst_regions.is_some());
let dst_set = dst_regions.unwrap();
assert_eq!(dst_set.len(), 2);
assert!(dst_set.contains(&RegionId::new(1024, 2)));
assert!(dst_set.contains(&RegionId::new(1024, 3)));
// Test non-existent source region
let nonexistent_src = RegionId::new(1024, 99);
let result = manager.get_dst_regions(nonexistent_src).await.unwrap();
assert!(result.is_none());
}
#[tokio::test]
async fn test_table_repart_manager_operations_on_nonexistent_table() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv);
let src = RegionId::new(1024, 1);
let dst = vec![RegionId::new(1024, 2)];
// Try to update mappings on non-existent table
let result = manager.update_mappings(src, &dst).await;
assert!(result.is_err());
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.contains("Failed to find table repartition metadata for table id 1024"),
"{err_msg}"
);
// Try to remove mappings on non-existent table
let result = manager.remove_mappings(src, &dst).await;
assert!(result.is_err());
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.contains("Failed to find table repartition metadata for table id 1024"),
"{err_msg}"
);
}
#[tokio::test]
async fn test_table_repart_manager_batch_get_with_raw_bytes() {
let kv = Arc::new(MemoryKvBackend::default());
let manager = TableRepartManager::new(kv.clone());
// Create table repart
let value = TableRepartValue {
src_to_dst: {
let mut map = BTreeMap::new();
map.insert(
RegionId::new(1, 1),
vec![RegionId::new(1, 2)].into_iter().collect(),
);
map
},
};
let (txn, _) = manager.build_create_txn(1024, &value).unwrap();
let result = kv.txn(txn).await.unwrap();
assert!(result.succeeded);
// Batch get with raw bytes
let results = manager
.batch_get_with_raw_bytes(&[1024, 1025])
.await
.unwrap();
assert_eq!(results.len(), 2);
assert!(results[0].is_some());
assert!(results[1].is_none());
let retrieved = &results[0].as_ref().unwrap().inner;
assert_eq!(retrieved, &value);
}
}

View File

@@ -71,6 +71,7 @@ pub struct PhysicalTableRouteValue {
#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)] #[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
pub struct LogicalTableRouteValue { pub struct LogicalTableRouteValue {
physical_table_id: TableId, physical_table_id: TableId,
region_ids: Vec<RegionId>,
} }
impl TableRouteValue { impl TableRouteValue {
@@ -84,7 +85,14 @@ impl TableRouteValue {
if table_id == physical_table_id { if table_id == physical_table_id {
TableRouteValue::physical(region_routes) TableRouteValue::physical(region_routes)
} else { } else {
TableRouteValue::logical(physical_table_id) let region_routes = region_routes
.into_iter()
.map(|region| {
debug_assert_eq!(region.region.id.table_id(), physical_table_id);
RegionId::new(table_id, region.region.id.region_number())
})
.collect();
TableRouteValue::logical(physical_table_id, region_routes)
} }
} }
@@ -92,8 +100,8 @@ impl TableRouteValue {
Self::Physical(PhysicalTableRouteValue::new(region_routes)) Self::Physical(PhysicalTableRouteValue::new(region_routes))
} }
pub fn logical(physical_table_id: TableId) -> Self { pub fn logical(physical_table_id: TableId, region_ids: Vec<RegionId>) -> Self {
Self::Logical(LogicalTableRouteValue::new(physical_table_id)) Self::Logical(LogicalTableRouteValue::new(physical_table_id, region_ids))
} }
/// Returns a new version [TableRouteValue] with `region_routes`. /// Returns a new version [TableRouteValue] with `region_routes`.
@@ -199,9 +207,11 @@ impl TableRouteValue {
.iter() .iter()
.map(|region_route| region_route.region.id.region_number()) .map(|region_route| region_route.region.id.region_number())
.collect(), .collect(),
TableRouteValue::Logical(_) => { TableRouteValue::Logical(x) => x
vec![] .region_ids()
} .iter()
.map(|region_id| region_id.region_number())
.collect(),
} }
} }
} }
@@ -235,13 +245,20 @@ impl PhysicalTableRouteValue {
} }
impl LogicalTableRouteValue { impl LogicalTableRouteValue {
pub fn new(physical_table_id: TableId) -> Self { pub fn new(physical_table_id: TableId, region_ids: Vec<RegionId>) -> Self {
Self { physical_table_id } Self {
physical_table_id,
region_ids,
}
} }
pub fn physical_table_id(&self) -> TableId { pub fn physical_table_id(&self) -> TableId {
self.physical_table_id self.physical_table_id
} }
pub fn region_ids(&self) -> &Vec<RegionId> {
&self.region_ids
}
} }
impl MetadataKey<'_, TableRouteKey> for TableRouteKey { impl MetadataKey<'_, TableRouteKey> for TableRouteKey {
@@ -883,6 +900,7 @@ mod tests {
let table_route_manager = TableRouteManager::new(kv.clone()); let table_route_manager = TableRouteManager::new(kv.clone());
let table_route_value = TableRouteValue::Logical(LogicalTableRouteValue { let table_route_value = TableRouteValue::Logical(LogicalTableRouteValue {
physical_table_id: 1023, physical_table_id: 1023,
region_ids: vec![RegionId::new(1023, 1)],
}); });
let (txn, _) = table_route_manager let (txn, _) = table_route_manager
.table_route_storage() .table_route_storage()
@@ -912,12 +930,14 @@ mod tests {
1024, 1024,
TableRouteValue::Logical(LogicalTableRouteValue { TableRouteValue::Logical(LogicalTableRouteValue {
physical_table_id: 1023, physical_table_id: 1023,
region_ids: vec![RegionId::new(1023, 1)],
}), }),
), ),
( (
1025, 1025,
TableRouteValue::Logical(LogicalTableRouteValue { TableRouteValue::Logical(LogicalTableRouteValue {
physical_table_id: 1023, physical_table_id: 1023,
region_ids: vec![RegionId::new(1023, 2)],
}), }),
), ),
]; ];

View File

@@ -19,7 +19,11 @@ use datatypes::schema::{ColumnSchema, SchemaBuilder};
use store_api::storage::TableId; use store_api::storage::TableId;
use table::metadata::{TableInfo, TableInfoBuilder, TableMetaBuilder}; use table::metadata::{TableInfo, TableInfoBuilder, TableMetaBuilder};
pub fn new_test_table_info_with_name(table_id: TableId, table_name: &str) -> TableInfo { pub fn new_test_table_info_with_name<I: IntoIterator<Item = u32>>(
table_id: TableId,
table_name: &str,
region_numbers: I,
) -> TableInfo {
let column_schemas = vec![ let column_schemas = vec![
ColumnSchema::new("col1", ConcreteDataType::int32_datatype(), true), ColumnSchema::new("col1", ConcreteDataType::int32_datatype(), true),
ColumnSchema::new( ColumnSchema::new(
@@ -41,6 +45,7 @@ pub fn new_test_table_info_with_name(table_id: TableId, table_name: &str) -> Tab
.primary_key_indices(vec![0]) .primary_key_indices(vec![0])
.engine("engine") .engine("engine")
.next_column_id(3) .next_column_id(3)
.region_numbers(region_numbers.into_iter().collect::<Vec<_>>())
.build() .build()
.unwrap(); .unwrap();
TableInfoBuilder::default() TableInfoBuilder::default()
@@ -51,6 +56,9 @@ pub fn new_test_table_info_with_name(table_id: TableId, table_name: &str) -> Tab
.build() .build()
.unwrap() .unwrap()
} }
pub fn new_test_table_info(table_id: TableId) -> TableInfo { pub fn new_test_table_info<I: IntoIterator<Item = u32>>(
new_test_table_info_with_name(table_id, "mytable") table_id: TableId,
region_numbers: I,
) -> TableInfo {
new_test_table_info_with_name(table_id, "mytable", region_numbers)
} }

View File

@@ -848,7 +848,7 @@ impl PgStore {
.context(CreatePostgresPoolSnafu)?, .context(CreatePostgresPoolSnafu)?,
}; };
Self::with_pg_pool(pool, None, table_name, max_txn_ops, false).await Self::with_pg_pool(pool, None, table_name, max_txn_ops).await
} }
/// Create [PgStore] impl of [KvBackendRef] from url (backward compatibility). /// Create [PgStore] impl of [KvBackendRef] from url (backward compatibility).
@@ -862,37 +862,20 @@ impl PgStore {
schema_name: Option<&str>, schema_name: Option<&str>,
table_name: &str, table_name: &str,
max_txn_ops: usize, max_txn_ops: usize,
auto_create_schema: bool,
) -> Result<KvBackendRef> { ) -> Result<KvBackendRef> {
// Ensure the postgres metadata backend is ready to use. // Ensure the postgres metadata backend is ready to use.
let client = match pool.get().await { let client = match pool.get().await {
Ok(client) => client, Ok(client) => client,
Err(e) => { Err(e) => {
// We need to log the debug for the error to help diagnose the issue.
common_telemetry::error!(e; "Failed to get Postgres connection.");
return GetPostgresConnectionSnafu { return GetPostgresConnectionSnafu {
reason: e.to_string(), reason: e.to_string(),
} }
.fail(); .fail();
} }
}; };
// Automatically create schema if enabled and schema_name is provided.
if auto_create_schema
&& let Some(schema) = schema_name
&& !schema.is_empty()
{
let create_schema_sql = format!("CREATE SCHEMA IF NOT EXISTS \"{}\"", schema);
client
.execute(&create_schema_sql, &[])
.await
.with_context(|_| PostgresExecutionSnafu {
sql: create_schema_sql.clone(),
})?;
}
let template_factory = PgSqlTemplateFactory::new(schema_name, table_name); let template_factory = PgSqlTemplateFactory::new(schema_name, table_name);
let sql_template_set = template_factory.build(); let sql_template_set = template_factory.build();
// Do not attempt to create schema implicitly.
client client
.execute(&sql_template_set.create_table_statement, &[]) .execute(&sql_template_set.create_table_statement, &[])
.await .await
@@ -976,7 +959,7 @@ mod tests {
let Some(pool) = build_pg15_pool().await else { let Some(pool) = build_pg15_pool().await else {
return; return;
}; };
let res = PgStore::with_pg_pool(pool, None, "pg15_public_should_fail", 128, false).await; let res = PgStore::with_pg_pool(pool, None, "pg15_public_should_fail", 128).await;
assert!( assert!(
res.is_err(), res.is_err(),
"creating table in public should fail for test_user" "creating table in public should fail for test_user"
@@ -1231,249 +1214,4 @@ mod tests {
let t = PgSqlTemplateFactory::format_table_ident(Some(""), "test_table"); let t = PgSqlTemplateFactory::format_table_ident(Some(""), "test_table");
assert_eq!(t, "\"test_table\""); assert_eq!(t, "\"test_table\"");
} }
#[tokio::test]
async fn test_auto_create_schema_enabled() {
common_telemetry::init_default_ut_logging();
maybe_skip_postgres_integration_test!();
let endpoints = std::env::var("GT_POSTGRES_ENDPOINTS").unwrap();
let mut cfg = Config::new();
cfg.url = Some(endpoints);
let pool = cfg
.create_pool(Some(Runtime::Tokio1), NoTls)
.context(CreatePostgresPoolSnafu)
.unwrap();
let schema_name = "test_auto_create_enabled";
let table_name = "test_table";
// Drop the schema if it exists to start clean
let client = pool.get().await.unwrap();
let _ = client
.execute(
&format!("DROP SCHEMA IF EXISTS \"{}\" CASCADE", schema_name),
&[],
)
.await;
// Create store with auto_create_schema enabled
let _ = PgStore::with_pg_pool(pool.clone(), Some(schema_name), table_name, 128, true)
.await
.unwrap();
// Verify schema was created
let row = client
.query_one(
"SELECT schema_name FROM information_schema.schemata WHERE schema_name = $1",
&[&schema_name],
)
.await
.unwrap();
let created_schema: String = row.get(0);
assert_eq!(created_schema, schema_name);
// Verify table was created in the schema
let row = client
.query_one(
"SELECT table_schema, table_name FROM information_schema.tables WHERE table_schema = $1 AND table_name = $2",
&[&schema_name, &table_name],
)
.await
.unwrap();
let created_table_schema: String = row.get(0);
let created_table_name: String = row.get(1);
assert_eq!(created_table_schema, schema_name);
assert_eq!(created_table_name, table_name);
// Cleanup
let _ = client
.execute(
&format!("DROP SCHEMA IF EXISTS \"{}\" CASCADE", schema_name),
&[],
)
.await;
}
#[tokio::test]
async fn test_auto_create_schema_disabled() {
common_telemetry::init_default_ut_logging();
maybe_skip_postgres_integration_test!();
let endpoints = std::env::var("GT_POSTGRES_ENDPOINTS").unwrap();
let mut cfg = Config::new();
cfg.url = Some(endpoints);
let pool = cfg
.create_pool(Some(Runtime::Tokio1), NoTls)
.context(CreatePostgresPoolSnafu)
.unwrap();
let schema_name = "test_auto_create_disabled";
let table_name = "test_table";
// Drop the schema if it exists to start clean
let client = pool.get().await.unwrap();
let _ = client
.execute(
&format!("DROP SCHEMA IF EXISTS \"{}\" CASCADE", schema_name),
&[],
)
.await;
// Try to create store with auto_create_schema disabled (should fail)
let result =
PgStore::with_pg_pool(pool.clone(), Some(schema_name), table_name, 128, false).await;
// Verify it failed because schema doesn't exist
assert!(
result.is_err(),
"Expected error when schema doesn't exist and auto_create_schema is disabled"
);
}
#[tokio::test]
async fn test_auto_create_schema_already_exists() {
common_telemetry::init_default_ut_logging();
maybe_skip_postgres_integration_test!();
let endpoints = std::env::var("GT_POSTGRES_ENDPOINTS").unwrap();
let mut cfg = Config::new();
cfg.url = Some(endpoints);
let pool = cfg
.create_pool(Some(Runtime::Tokio1), NoTls)
.context(CreatePostgresPoolSnafu)
.unwrap();
let schema_name = "test_auto_create_existing";
let table_name = "test_table";
// Manually create the schema first
let client = pool.get().await.unwrap();
let _ = client
.execute(
&format!("DROP SCHEMA IF EXISTS \"{}\" CASCADE", schema_name),
&[],
)
.await;
client
.execute(&format!("CREATE SCHEMA \"{}\"", schema_name), &[])
.await
.unwrap();
// Create store with auto_create_schema enabled (should succeed idempotently)
let _ = PgStore::with_pg_pool(pool.clone(), Some(schema_name), table_name, 128, true)
.await
.unwrap();
// Verify schema still exists
let row = client
.query_one(
"SELECT schema_name FROM information_schema.schemata WHERE schema_name = $1",
&[&schema_name],
)
.await
.unwrap();
let created_schema: String = row.get(0);
assert_eq!(created_schema, schema_name);
// Verify table was created in the schema
let row = client
.query_one(
"SELECT table_schema, table_name FROM information_schema.tables WHERE table_schema = $1 AND table_name = $2",
&[&schema_name, &table_name],
)
.await
.unwrap();
let created_table_schema: String = row.get(0);
let created_table_name: String = row.get(1);
assert_eq!(created_table_schema, schema_name);
assert_eq!(created_table_name, table_name);
// Cleanup
let _ = client
.execute(
&format!("DROP SCHEMA IF EXISTS \"{}\" CASCADE", schema_name),
&[],
)
.await;
}
#[tokio::test]
async fn test_auto_create_schema_no_schema_name() {
common_telemetry::init_default_ut_logging();
maybe_skip_postgres_integration_test!();
let endpoints = std::env::var("GT_POSTGRES_ENDPOINTS").unwrap();
let mut cfg = Config::new();
cfg.url = Some(endpoints);
let pool = cfg
.create_pool(Some(Runtime::Tokio1), NoTls)
.context(CreatePostgresPoolSnafu)
.unwrap();
let table_name = "test_table_no_schema";
// Create store with auto_create_schema enabled but no schema name (should succeed)
// This should create the table in the default schema (public)
let _ = PgStore::with_pg_pool(pool.clone(), None, table_name, 128, true)
.await
.unwrap();
// Verify table was created in public schema
let client = pool.get().await.unwrap();
let row = client
.query_one(
"SELECT table_schema, table_name FROM information_schema.tables WHERE table_name = $1",
&[&table_name],
)
.await
.unwrap();
let created_table_schema: String = row.get(0);
let created_table_name: String = row.get(1);
assert_eq!(created_table_name, table_name);
// Verify it's in public schema (or whichever is the default)
assert!(created_table_schema == "public" || !created_table_schema.is_empty());
// Cleanup
let _ = client
.execute(&format!("DROP TABLE IF EXISTS \"{}\"", table_name), &[])
.await;
}
#[tokio::test]
async fn test_auto_create_schema_with_empty_schema_name() {
common_telemetry::init_default_ut_logging();
maybe_skip_postgres_integration_test!();
let endpoints = std::env::var("GT_POSTGRES_ENDPOINTS").unwrap();
let mut cfg = Config::new();
cfg.url = Some(endpoints);
let pool = cfg
.create_pool(Some(Runtime::Tokio1), NoTls)
.context(CreatePostgresPoolSnafu)
.unwrap();
let table_name = "test_table_empty_schema";
// Create store with auto_create_schema enabled but empty schema name (should succeed)
// This should create the table in the default schema (public)
let _ = PgStore::with_pg_pool(pool.clone(), Some(""), table_name, 128, true)
.await
.unwrap();
// Verify table was created in public schema
let client = pool.get().await.unwrap();
let row = client
.query_one(
"SELECT table_schema, table_name FROM information_schema.tables WHERE table_name = $1",
&[&table_name],
)
.await
.unwrap();
let created_table_schema: String = row.get(0);
let created_table_name: String = row.get(1);
assert_eq!(created_table_name, table_name);
// Verify it's in public schema (or whichever is the default)
assert!(created_table_schema == "public" || !created_table_schema.is_empty());
// Cleanup
let _ = client
.execute(&format!("DROP TABLE IF EXISTS \"{}\"", table_name), &[])
.await;
}
} }

View File

@@ -1639,6 +1639,7 @@ mod tests {
value_indices: vec![2], value_indices: vec![2],
engine: METRIC_ENGINE_NAME.to_string(), engine: METRIC_ENGINE_NAME.to_string(),
next_column_id: 0, next_column_id: 0,
region_numbers: vec![0],
options: Default::default(), options: Default::default(),
created_on: Default::default(), created_on: Default::default(),
updated_on: Default::default(), updated_on: Default::default(),

View File

@@ -14,7 +14,7 @@
use common_telemetry::{debug, error, info}; use common_telemetry::{debug, error, info};
use common_wal::config::kafka::common::{ use common_wal::config::kafka::common::{
DEFAULT_BACKOFF_CONFIG, KafkaConnectionConfig, KafkaTopicConfig, DEFAULT_BACKOFF_CONFIG, DEFAULT_CONNECT_TIMEOUT, KafkaConnectionConfig, KafkaTopicConfig,
}; };
use rskafka::client::error::Error as RsKafkaError; use rskafka::client::error::Error as RsKafkaError;
use rskafka::client::error::ProtocolError::TopicAlreadyExists; use rskafka::client::error::ProtocolError::TopicAlreadyExists;
@@ -211,8 +211,7 @@ pub async fn build_kafka_client(connection: &KafkaConnectionConfig) -> Result<Cl
// Builds an kafka controller client for creating topics. // Builds an kafka controller client for creating topics.
let mut builder = ClientBuilder::new(connection.broker_endpoints.clone()) let mut builder = ClientBuilder::new(connection.broker_endpoints.clone())
.backoff_config(DEFAULT_BACKOFF_CONFIG) .backoff_config(DEFAULT_BACKOFF_CONFIG)
.connect_timeout(Some(connection.connect_timeout)) .connect_timeout(Some(DEFAULT_CONNECT_TIMEOUT));
.timeout(Some(connection.timeout));
if let Some(sasl) = &connection.sasl { if let Some(sasl) = &connection.sasl {
builder = builder.sasl_config(sasl.config.clone().into_sasl_config()); builder = builder.sasl_config(sasl.config.clone().into_sasl_config());
}; };

View File

@@ -21,7 +21,6 @@ use std::sync::Arc;
use std::task::{Context, Poll}; use std::task::{Context, Poll};
use common_base::readable_size::ReadableSize; use common_base::readable_size::ReadableSize;
use common_telemetry::tracing::{Span, info_span};
use common_time::util::format_nanoseconds_human_readable; use common_time::util::format_nanoseconds_human_readable;
use datafusion::arrow::compute::cast; use datafusion::arrow::compute::cast;
use datafusion::arrow::datatypes::SchemaRef as DfSchemaRef; use datafusion::arrow::datatypes::SchemaRef as DfSchemaRef;
@@ -219,7 +218,6 @@ pub struct RecordBatchStreamAdapter {
metrics_2: Metrics, metrics_2: Metrics,
/// Display plan and metrics in verbose mode. /// Display plan and metrics in verbose mode.
explain_verbose: bool, explain_verbose: bool,
span: Span,
} }
/// Json encoded metrics. Contains metric from a whole plan tree. /// Json encoded metrics. Contains metric from a whole plan tree.
@@ -240,21 +238,22 @@ impl RecordBatchStreamAdapter {
metrics: None, metrics: None,
metrics_2: Metrics::Unavailable, metrics_2: Metrics::Unavailable,
explain_verbose: false, explain_verbose: false,
span: Span::current(),
}) })
} }
pub fn try_new_with_span(stream: DfSendableRecordBatchStream, span: Span) -> Result<Self> { pub fn try_new_with_metrics_and_df_plan(
stream: DfSendableRecordBatchStream,
metrics: BaselineMetrics,
df_plan: Arc<dyn ExecutionPlan>,
) -> Result<Self> {
let schema = let schema =
Arc::new(Schema::try_from(stream.schema()).context(error::SchemaConversionSnafu)?); Arc::new(Schema::try_from(stream.schema()).context(error::SchemaConversionSnafu)?);
let subspan = info_span!(parent: &span, "RecordBatchStreamAdapter");
Ok(Self { Ok(Self {
schema, schema,
stream, stream,
metrics: None, metrics: Some(metrics),
metrics_2: Metrics::Unavailable, metrics_2: Metrics::Unresolved(df_plan),
explain_verbose: false, explain_verbose: false,
span: subspan,
}) })
} }
@@ -301,8 +300,6 @@ impl Stream for RecordBatchStreamAdapter {
.map(|m| m.elapsed_compute().clone()) .map(|m| m.elapsed_compute().clone())
.unwrap_or_default(); .unwrap_or_default();
let _guard = timer.timer(); let _guard = timer.timer();
let poll_span = info_span!(parent: &self.span, "poll_next");
let _entered = poll_span.enter();
match Pin::new(&mut self.stream).poll_next(cx) { match Pin::new(&mut self.stream).poll_next(cx) {
Poll::Pending => Poll::Pending, Poll::Pending => Poll::Pending,
Poll::Ready(Some(df_record_batch)) => { Poll::Ready(Some(df_record_batch)) => {

View File

@@ -29,7 +29,6 @@ use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use adapter::RecordBatchMetrics; use adapter::RecordBatchMetrics;
use arc_swap::ArcSwapOption; use arc_swap::ArcSwapOption;
use common_base::readable_size::ReadableSize; use common_base::readable_size::ReadableSize;
use common_telemetry::tracing::Span;
pub use datafusion::physical_plan::SendableRecordBatchStream as DfSendableRecordBatchStream; pub use datafusion::physical_plan::SendableRecordBatchStream as DfSendableRecordBatchStream;
use datatypes::arrow::array::{ArrayRef, AsArray, StringBuilder}; use datatypes::arrow::array::{ArrayRef, AsArray, StringBuilder};
use datatypes::arrow::compute::SortOptions; use datatypes::arrow::compute::SortOptions;
@@ -371,7 +370,6 @@ pub struct RecordBatchStreamWrapper<S> {
pub stream: S, pub stream: S,
pub output_ordering: Option<Vec<OrderOption>>, pub output_ordering: Option<Vec<OrderOption>>,
pub metrics: Arc<ArcSwapOption<RecordBatchMetrics>>, pub metrics: Arc<ArcSwapOption<RecordBatchMetrics>>,
pub span: Span,
} }
impl<S> RecordBatchStreamWrapper<S> { impl<S> RecordBatchStreamWrapper<S> {
@@ -382,7 +380,6 @@ impl<S> RecordBatchStreamWrapper<S> {
stream, stream,
output_ordering: None, output_ordering: None,
metrics: Default::default(), metrics: Default::default(),
span: Span::current(),
} }
} }
} }
@@ -411,7 +408,6 @@ impl<S: Stream<Item = Result<RecordBatch>> + Unpin> Stream for RecordBatchStream
type Item = Result<RecordBatch>; type Item = Result<RecordBatch>;
fn poll_next(mut self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Option<Self::Item>> { fn poll_next(mut self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let _entered = self.span.clone().entered();
Pin::new(&mut self.stream).poll_next(ctx) Pin::new(&mut self.stream).poll_next(ctx)
} }
} }

View File

@@ -5,12 +5,10 @@ edition.workspace = true
license.workspace = true license.workspace = true
[dependencies] [dependencies]
arrow-schema.workspace = true
common-base.workspace = true common-base.workspace = true
common-decimal.workspace = true common-decimal.workspace = true
common-error.workspace = true common-error.workspace = true
common-macro.workspace = true common-macro.workspace = true
common-telemetry.workspace = true
common-time.workspace = true common-time.workspace = true
datafusion-sql.workspace = true datafusion-sql.workspace = true
datatypes.workspace = true datatypes.workspace = true

View File

@@ -14,12 +14,11 @@
use std::str::FromStr; use std::str::FromStr;
use arrow_schema::extension::ExtensionType;
use common_time::Timestamp; use common_time::Timestamp;
use common_time::timezone::Timezone; use common_time::timezone::Timezone;
use datatypes::extension::json::JsonExtensionType; use datatypes::json::JsonStructureSettings;
use datatypes::prelude::ConcreteDataType; use datatypes::prelude::ConcreteDataType;
use datatypes::schema::{ColumnDefaultConstraint, ColumnSchema}; use datatypes::schema::ColumnDefaultConstraint;
use datatypes::types::{JsonFormat, parse_string_to_jsonb, parse_string_to_vector_type_value}; use datatypes::types::{JsonFormat, parse_string_to_jsonb, parse_string_to_vector_type_value};
use datatypes::value::{OrderedF32, OrderedF64, Value}; use datatypes::value::{OrderedF32, OrderedF64, Value};
use snafu::{OptionExt, ResultExt, ensure}; use snafu::{OptionExt, ResultExt, ensure};
@@ -125,14 +124,13 @@ pub(crate) fn sql_number_to_value(data_type: &ConcreteDataType, n: &str) -> Resu
/// If `auto_string_to_numeric` is true, tries to cast the string value to numeric values, /// If `auto_string_to_numeric` is true, tries to cast the string value to numeric values,
/// and returns error if the cast fails. /// and returns error if the cast fails.
pub fn sql_value_to_value( pub fn sql_value_to_value(
column_schema: &ColumnSchema, column_name: &str,
data_type: &ConcreteDataType,
sql_val: &SqlValue, sql_val: &SqlValue,
timezone: Option<&Timezone>, timezone: Option<&Timezone>,
unary_op: Option<UnaryOperator>, unary_op: Option<UnaryOperator>,
auto_string_to_numeric: bool, auto_string_to_numeric: bool,
) -> Result<Value> { ) -> Result<Value> {
let column_name = &column_schema.name;
let data_type = &column_schema.data_type;
let mut value = match sql_val { let mut value = match sql_val {
SqlValue::Number(n, _) => sql_number_to_value(data_type, n)?, SqlValue::Number(n, _) => sql_number_to_value(data_type, n)?,
SqlValue::Null => Value::Null, SqlValue::Null => Value::Null,
@@ -148,9 +146,13 @@ pub fn sql_value_to_value(
(*b).into() (*b).into()
} }
SqlValue::DoubleQuotedString(s) | SqlValue::SingleQuotedString(s) => { SqlValue::DoubleQuotedString(s) | SqlValue::SingleQuotedString(s) => parse_string_to_value(
parse_string_to_value(column_schema, s.clone(), timezone, auto_string_to_numeric)? column_name,
} s.clone(),
data_type,
timezone,
auto_string_to_numeric,
)?,
SqlValue::HexStringLiteral(s) => { SqlValue::HexStringLiteral(s) => {
// Should not directly write binary into json column // Should not directly write binary into json column
ensure!( ensure!(
@@ -242,12 +244,12 @@ pub fn sql_value_to_value(
} }
pub(crate) fn parse_string_to_value( pub(crate) fn parse_string_to_value(
column_schema: &ColumnSchema, column_name: &str,
s: String, s: String,
data_type: &ConcreteDataType,
timezone: Option<&Timezone>, timezone: Option<&Timezone>,
auto_string_to_numeric: bool, auto_string_to_numeric: bool,
) -> Result<Value> { ) -> Result<Value> {
let data_type = &column_schema.data_type;
if auto_string_to_numeric && let Some(value) = auto_cast_to_numeric(&s, data_type)? { if auto_string_to_numeric && let Some(value) = auto_cast_to_numeric(&s, data_type)? {
return Ok(value); return Ok(value);
} }
@@ -255,7 +257,7 @@ pub(crate) fn parse_string_to_value(
ensure!( ensure!(
data_type.is_stringifiable(), data_type.is_stringifiable(),
ColumnTypeMismatchSnafu { ColumnTypeMismatchSnafu {
column_name: column_schema.name.clone(), column_name,
expect: data_type.clone(), expect: data_type.clone(),
actual: ConcreteDataType::string_datatype(), actual: ConcreteDataType::string_datatype(),
} }
@@ -301,21 +303,23 @@ pub(crate) fn parse_string_to_value(
} }
} }
ConcreteDataType::Binary(_) => Ok(Value::Binary(s.as_bytes().into())), ConcreteDataType::Binary(_) => Ok(Value::Binary(s.as_bytes().into())),
ConcreteDataType::Json(j) => match &j.format { ConcreteDataType::Json(j) => {
JsonFormat::Jsonb => { match &j.format {
let v = parse_string_to_jsonb(&s).context(DatatypeSnafu)?; JsonFormat::Jsonb => {
Ok(Value::Binary(v.into())) let v = parse_string_to_jsonb(&s).context(DatatypeSnafu)?;
Ok(Value::Binary(v.into()))
}
JsonFormat::Native(_inner) => {
// Always use the structured version at this level.
let serde_json_value =
serde_json::from_str(&s).context(DeserializeSnafu { json: s })?;
let json_structure_settings = JsonStructureSettings::Structured(None);
json_structure_settings
.encode(serde_json_value)
.context(DatatypeSnafu)
}
} }
JsonFormat::Native(_) => { }
let extension_type: Option<JsonExtensionType> =
column_schema.extension_type().context(DatatypeSnafu)?;
let json_structure_settings = extension_type
.and_then(|x| x.metadata().json_structure_settings.clone())
.unwrap_or_default();
let v = serde_json::from_str(&s).context(DeserializeSnafu { json: s })?;
json_structure_settings.encode(v).context(DatatypeSnafu)
}
},
ConcreteDataType::Vector(d) => { ConcreteDataType::Vector(d) => {
let v = parse_string_to_vector_type_value(&s, Some(d.dim)).context(DatatypeSnafu)?; let v = parse_string_to_vector_type_value(&s, Some(d.dim)).context(DatatypeSnafu)?;
Ok(Value::Binary(v.into())) Ok(Value::Binary(v.into()))
@@ -413,265 +417,305 @@ mod test {
use super::*; use super::*;
macro_rules! call_parse_string_to_value {
($column_name: expr, $input: expr, $data_type: expr) => {
call_parse_string_to_value!($column_name, $input, $data_type, None)
};
($column_name: expr, $input: expr, $data_type: expr, timezone = $timezone: expr) => {
call_parse_string_to_value!($column_name, $input, $data_type, Some($timezone))
};
($column_name: expr, $input: expr, $data_type: expr, $timezone: expr) => {{
let column_schema = ColumnSchema::new($column_name, $data_type, true);
parse_string_to_value(&column_schema, $input, $timezone, true)
}};
}
#[test] #[test]
fn test_string_to_value_auto_numeric() -> Result<()> { fn test_string_to_value_auto_numeric() {
// Test string to boolean with auto cast // Test string to boolean with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"true".to_string(), "true".to_string(),
ConcreteDataType::boolean_datatype() &ConcreteDataType::boolean_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Boolean(true), result); assert_eq!(Value::Boolean(true), result);
// Test invalid string to boolean with auto cast // Test invalid string to boolean with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_boolean".to_string(), "not_a_boolean".to_string(),
ConcreteDataType::boolean_datatype() &ConcreteDataType::boolean_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to int8 // Test string to int8
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"42".to_string(), "42".to_string(),
ConcreteDataType::int8_datatype() &ConcreteDataType::int8_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Int8(42), result); assert_eq!(Value::Int8(42), result);
// Test invalid string to int8 with auto cast // Test invalid string to int8 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_an_int8".to_string(), "not_an_int8".to_string(),
ConcreteDataType::int8_datatype() &ConcreteDataType::int8_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to int16 // Test string to int16
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"1000".to_string(), "1000".to_string(),
ConcreteDataType::int16_datatype() &ConcreteDataType::int16_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Int16(1000), result); assert_eq!(Value::Int16(1000), result);
// Test invalid string to int16 with auto cast // Test invalid string to int16 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_an_int16".to_string(), "not_an_int16".to_string(),
ConcreteDataType::int16_datatype() &ConcreteDataType::int16_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to int32 // Test string to int32
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"100000".to_string(), "100000".to_string(),
ConcreteDataType::int32_datatype() &ConcreteDataType::int32_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Int32(100000), result); assert_eq!(Value::Int32(100000), result);
// Test invalid string to int32 with auto cast // Test invalid string to int32 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_an_int32".to_string(), "not_an_int32".to_string(),
ConcreteDataType::int32_datatype() &ConcreteDataType::int32_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to int64 // Test string to int64
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"1000000".to_string(), "1000000".to_string(),
ConcreteDataType::int64_datatype() &ConcreteDataType::int64_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Int64(1000000), result); assert_eq!(Value::Int64(1000000), result);
// Test invalid string to int64 with auto cast // Test invalid string to int64 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_an_int64".to_string(), "not_an_int64".to_string(),
ConcreteDataType::int64_datatype() &ConcreteDataType::int64_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to uint8 // Test string to uint8
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"200".to_string(), "200".to_string(),
ConcreteDataType::uint8_datatype() &ConcreteDataType::uint8_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::UInt8(200), result); assert_eq!(Value::UInt8(200), result);
// Test invalid string to uint8 with auto cast // Test invalid string to uint8 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_uint8".to_string(), "not_a_uint8".to_string(),
ConcreteDataType::uint8_datatype() &ConcreteDataType::uint8_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to uint16 // Test string to uint16
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"60000".to_string(), "60000".to_string(),
ConcreteDataType::uint16_datatype() &ConcreteDataType::uint16_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::UInt16(60000), result); assert_eq!(Value::UInt16(60000), result);
// Test invalid string to uint16 with auto cast // Test invalid string to uint16 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_uint16".to_string(), "not_a_uint16".to_string(),
ConcreteDataType::uint16_datatype() &ConcreteDataType::uint16_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to uint32 // Test string to uint32
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"4000000000".to_string(), "4000000000".to_string(),
ConcreteDataType::uint32_datatype() &ConcreteDataType::uint32_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::UInt32(4000000000), result); assert_eq!(Value::UInt32(4000000000), result);
// Test invalid string to uint32 with auto cast // Test invalid string to uint32 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_uint32".to_string(), "not_a_uint32".to_string(),
ConcreteDataType::uint32_datatype() &ConcreteDataType::uint32_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to uint64 // Test string to uint64
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"18446744073709551615".to_string(), "18446744073709551615".to_string(),
ConcreteDataType::uint64_datatype() &ConcreteDataType::uint64_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::UInt64(18446744073709551615), result); assert_eq!(Value::UInt64(18446744073709551615), result);
// Test invalid string to uint64 with auto cast // Test invalid string to uint64 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_uint64".to_string(), "not_a_uint64".to_string(),
ConcreteDataType::uint64_datatype() &ConcreteDataType::uint64_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to float32 // Test string to float32
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"3.5".to_string(), "3.5".to_string(),
ConcreteDataType::float32_datatype() &ConcreteDataType::float32_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Float32(OrderedF32::from(3.5)), result); assert_eq!(Value::Float32(OrderedF32::from(3.5)), result);
// Test invalid string to float32 with auto cast // Test invalid string to float32 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_float32".to_string(), "not_a_float32".to_string(),
ConcreteDataType::float32_datatype() &ConcreteDataType::float32_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
// Test string to float64 // Test string to float64
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"3.5".to_string(), "3.5".to_string(),
ConcreteDataType::float64_datatype() &ConcreteDataType::float64_datatype(),
)?; None,
true,
)
.unwrap();
assert_eq!(Value::Float64(OrderedF64::from(3.5)), result); assert_eq!(Value::Float64(OrderedF64::from(3.5)), result);
// Test invalid string to float64 with auto cast // Test invalid string to float64 with auto cast
let result = call_parse_string_to_value!( let result = parse_string_to_value(
"col", "col",
"not_a_float64".to_string(), "not_a_float64".to_string(),
ConcreteDataType::float64_datatype() &ConcreteDataType::float64_datatype(),
None,
true,
); );
assert!(result.is_err()); assert!(result.is_err());
Ok(())
}
macro_rules! call_sql_value_to_value {
($column_name: expr, $data_type: expr, $sql_value: expr) => {
call_sql_value_to_value!($column_name, $data_type, $sql_value, None, None, false)
};
($column_name: expr, $data_type: expr, $sql_value: expr, timezone = $timezone: expr) => {
call_sql_value_to_value!(
$column_name,
$data_type,
$sql_value,
Some($timezone),
None,
false
)
};
($column_name: expr, $data_type: expr, $sql_value: expr, unary_op = $unary_op: expr) => {
call_sql_value_to_value!(
$column_name,
$data_type,
$sql_value,
None,
Some($unary_op),
false
)
};
($column_name: expr, $data_type: expr, $sql_value: expr, auto_string_to_numeric) => {
call_sql_value_to_value!($column_name, $data_type, $sql_value, None, None, true)
};
($column_name: expr, $data_type: expr, $sql_value: expr, $timezone: expr, $unary_op: expr, $auto_string_to_numeric: expr) => {{
let column_schema = ColumnSchema::new($column_name, $data_type, true);
sql_value_to_value(
&column_schema,
$sql_value,
$timezone,
$unary_op,
$auto_string_to_numeric,
)
}};
} }
#[test] #[test]
fn test_sql_value_to_value() -> Result<()> { fn test_sql_value_to_value() {
let sql_val = SqlValue::Null; let sql_val = SqlValue::Null;
assert_eq!( assert_eq!(
Value::Null, Value::Null,
call_sql_value_to_value!("a", ConcreteDataType::float64_datatype(), &sql_val)? sql_value_to_value(
"a",
&ConcreteDataType::float64_datatype(),
&sql_val,
None,
None,
false
)
.unwrap()
); );
let sql_val = SqlValue::Boolean(true); let sql_val = SqlValue::Boolean(true);
assert_eq!( assert_eq!(
Value::Boolean(true), Value::Boolean(true),
call_sql_value_to_value!("a", ConcreteDataType::boolean_datatype(), &sql_val)? sql_value_to_value(
"a",
&ConcreteDataType::boolean_datatype(),
&sql_val,
None,
None,
false
)
.unwrap()
); );
let sql_val = SqlValue::Number("3.0".to_string(), false); let sql_val = SqlValue::Number("3.0".to_string(), false);
assert_eq!( assert_eq!(
Value::Float64(OrderedFloat(3.0)), Value::Float64(OrderedFloat(3.0)),
call_sql_value_to_value!("a", ConcreteDataType::float64_datatype(), &sql_val)? sql_value_to_value(
"a",
&ConcreteDataType::float64_datatype(),
&sql_val,
None,
None,
false
)
.unwrap()
); );
let sql_val = SqlValue::Number("3.0".to_string(), false); let sql_val = SqlValue::Number("3.0".to_string(), false);
let v = call_sql_value_to_value!("a", ConcreteDataType::boolean_datatype(), &sql_val); let v = sql_value_to_value(
"a",
&ConcreteDataType::boolean_datatype(),
&sql_val,
None,
None,
false,
);
assert!(v.is_err()); assert!(v.is_err());
assert!(format!("{v:?}").contains("Failed to parse number '3.0' to boolean column type")); assert!(format!("{v:?}").contains("Failed to parse number '3.0' to boolean column type"));
let sql_val = SqlValue::Boolean(true); let sql_val = SqlValue::Boolean(true);
let v = call_sql_value_to_value!("a", ConcreteDataType::float64_datatype(), &sql_val); let v = sql_value_to_value(
"a",
&ConcreteDataType::float64_datatype(),
&sql_val,
None,
None,
false,
);
assert!(v.is_err()); assert!(v.is_err());
assert!( assert!(
format!("{v:?}").contains( format!("{v:?}").contains(
@@ -681,18 +725,41 @@ mod test {
); );
let sql_val = SqlValue::HexStringLiteral("48656c6c6f20776f726c6421".to_string()); let sql_val = SqlValue::HexStringLiteral("48656c6c6f20776f726c6421".to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::binary_datatype(), &sql_val)?; let v = sql_value_to_value(
"a",
&ConcreteDataType::binary_datatype(),
&sql_val,
None,
None,
false,
)
.unwrap();
assert_eq!(Value::Binary(Bytes::from(b"Hello world!".as_slice())), v); assert_eq!(Value::Binary(Bytes::from(b"Hello world!".as_slice())), v);
let sql_val = SqlValue::DoubleQuotedString("MorningMyFriends".to_string()); let sql_val = SqlValue::DoubleQuotedString("MorningMyFriends".to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::binary_datatype(), &sql_val)?; let v = sql_value_to_value(
"a",
&ConcreteDataType::binary_datatype(),
&sql_val,
None,
None,
false,
)
.unwrap();
assert_eq!( assert_eq!(
Value::Binary(Bytes::from(b"MorningMyFriends".as_slice())), Value::Binary(Bytes::from(b"MorningMyFriends".as_slice())),
v v
); );
let sql_val = SqlValue::HexStringLiteral("9AF".to_string()); let sql_val = SqlValue::HexStringLiteral("9AF".to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::binary_datatype(), &sql_val); let v = sql_value_to_value(
"a",
&ConcreteDataType::binary_datatype(),
&sql_val,
None,
None,
false,
);
assert!(v.is_err()); assert!(v.is_err());
assert!( assert!(
format!("{v:?}").contains("odd number of digits"), format!("{v:?}").contains("odd number of digits"),
@@ -700,16 +767,38 @@ mod test {
); );
let sql_val = SqlValue::HexStringLiteral("AG".to_string()); let sql_val = SqlValue::HexStringLiteral("AG".to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::binary_datatype(), &sql_val); let v = sql_value_to_value(
"a",
&ConcreteDataType::binary_datatype(),
&sql_val,
None,
None,
false,
);
assert!(v.is_err()); assert!(v.is_err());
assert!(format!("{v:?}").contains("invalid character"), "v is {v:?}",); assert!(format!("{v:?}").contains("invalid character"), "v is {v:?}",);
let sql_val = SqlValue::DoubleQuotedString("MorningMyFriends".to_string()); let sql_val = SqlValue::DoubleQuotedString("MorningMyFriends".to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::json_datatype(), &sql_val); let v = sql_value_to_value(
"a",
&ConcreteDataType::json_datatype(),
&sql_val,
None,
None,
false,
);
assert!(v.is_err()); assert!(v.is_err());
let sql_val = SqlValue::DoubleQuotedString(r#"{"a":"b"}"#.to_string()); let sql_val = SqlValue::DoubleQuotedString(r#"{"a":"b"}"#.to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::json_datatype(), &sql_val)?; let v = sql_value_to_value(
"a",
&ConcreteDataType::json_datatype(),
&sql_val,
None,
None,
false,
)
.unwrap();
assert_eq!( assert_eq!(
Value::Binary(Bytes::from( Value::Binary(Bytes::from(
jsonb::parse_value(r#"{"a":"b"}"#.as_bytes()) jsonb::parse_value(r#"{"a":"b"}"#.as_bytes())
@@ -719,15 +808,16 @@ mod test {
)), )),
v v
); );
Ok(())
} }
#[test] #[test]
fn test_parse_json_to_jsonb() { fn test_parse_json_to_jsonb() {
match call_parse_string_to_value!( match parse_string_to_value(
"json_col", "json_col",
r#"{"a": "b"}"#.to_string(), r#"{"a": "b"}"#.to_string(),
ConcreteDataType::json_datatype() &ConcreteDataType::json_datatype(),
None,
false,
) { ) {
Ok(Value::Binary(b)) => { Ok(Value::Binary(b)) => {
assert_eq!( assert_eq!(
@@ -743,10 +833,12 @@ mod test {
} }
assert!( assert!(
call_parse_string_to_value!( parse_string_to_value(
"json_col", "json_col",
r#"Nicola Kovac is the best rifler in the world"#.to_string(), r#"Nicola Kovac is the best rifler in the world"#.to_string(),
ConcreteDataType::json_datatype() &ConcreteDataType::json_datatype(),
None,
false,
) )
.is_err() .is_err()
) )
@@ -786,10 +878,13 @@ mod test {
#[test] #[test]
fn test_parse_date_literal() { fn test_parse_date_literal() {
let value = call_sql_value_to_value!( let value = sql_value_to_value(
"date", "date",
ConcreteDataType::date_datatype(), &ConcreteDataType::date_datatype(),
&SqlValue::DoubleQuotedString("2022-02-22".to_string()) &SqlValue::DoubleQuotedString("2022-02-22".to_string()),
None,
None,
false,
) )
.unwrap(); .unwrap();
assert_eq!(ConcreteDataType::date_datatype(), value.data_type()); assert_eq!(ConcreteDataType::date_datatype(), value.data_type());
@@ -800,11 +895,13 @@ mod test {
} }
// with timezone // with timezone
let value = call_sql_value_to_value!( let value = sql_value_to_value(
"date", "date",
ConcreteDataType::date_datatype(), &ConcreteDataType::date_datatype(),
&SqlValue::DoubleQuotedString("2022-02-22".to_string()), &SqlValue::DoubleQuotedString("2022-02-22".to_string()),
timezone = &Timezone::from_tz_string("+07:00").unwrap() Some(&Timezone::from_tz_string("+07:00").unwrap()),
None,
false,
) )
.unwrap(); .unwrap();
assert_eq!(ConcreteDataType::date_datatype(), value.data_type()); assert_eq!(ConcreteDataType::date_datatype(), value.data_type());
@@ -816,12 +913,16 @@ mod test {
} }
#[test] #[test]
fn test_parse_timestamp_literal() -> Result<()> { fn test_parse_timestamp_literal() {
match call_parse_string_to_value!( match parse_string_to_value(
"timestamp_col", "timestamp_col",
"2022-02-22T00:01:01+08:00".to_string(), "2022-02-22T00:01:01+08:00".to_string(),
ConcreteDataType::timestamp_millisecond_datatype() &ConcreteDataType::timestamp_millisecond_datatype(),
)? { None,
false,
)
.unwrap()
{
Value::Timestamp(ts) => { Value::Timestamp(ts) => {
assert_eq!(1645459261000, ts.value()); assert_eq!(1645459261000, ts.value());
assert_eq!(TimeUnit::Millisecond, ts.unit()); assert_eq!(TimeUnit::Millisecond, ts.unit());
@@ -831,11 +932,15 @@ mod test {
} }
} }
match call_parse_string_to_value!( match parse_string_to_value(
"timestamp_col", "timestamp_col",
"2022-02-22T00:01:01+08:00".to_string(), "2022-02-22T00:01:01+08:00".to_string(),
ConcreteDataType::timestamp_datatype(TimeUnit::Second) &ConcreteDataType::timestamp_datatype(TimeUnit::Second),
)? { None,
false,
)
.unwrap()
{
Value::Timestamp(ts) => { Value::Timestamp(ts) => {
assert_eq!(1645459261, ts.value()); assert_eq!(1645459261, ts.value());
assert_eq!(TimeUnit::Second, ts.unit()); assert_eq!(TimeUnit::Second, ts.unit());
@@ -845,11 +950,15 @@ mod test {
} }
} }
match call_parse_string_to_value!( match parse_string_to_value(
"timestamp_col", "timestamp_col",
"2022-02-22T00:01:01+08:00".to_string(), "2022-02-22T00:01:01+08:00".to_string(),
ConcreteDataType::timestamp_datatype(TimeUnit::Microsecond) &ConcreteDataType::timestamp_datatype(TimeUnit::Microsecond),
)? { None,
false,
)
.unwrap()
{
Value::Timestamp(ts) => { Value::Timestamp(ts) => {
assert_eq!(1645459261000000, ts.value()); assert_eq!(1645459261000000, ts.value());
assert_eq!(TimeUnit::Microsecond, ts.unit()); assert_eq!(TimeUnit::Microsecond, ts.unit());
@@ -859,11 +968,15 @@ mod test {
} }
} }
match call_parse_string_to_value!( match parse_string_to_value(
"timestamp_col", "timestamp_col",
"2022-02-22T00:01:01+08:00".to_string(), "2022-02-22T00:01:01+08:00".to_string(),
ConcreteDataType::timestamp_datatype(TimeUnit::Nanosecond) &ConcreteDataType::timestamp_datatype(TimeUnit::Nanosecond),
)? { None,
false,
)
.unwrap()
{
Value::Timestamp(ts) => { Value::Timestamp(ts) => {
assert_eq!(1645459261000000000, ts.value()); assert_eq!(1645459261000000000, ts.value());
assert_eq!(TimeUnit::Nanosecond, ts.unit()); assert_eq!(TimeUnit::Nanosecond, ts.unit());
@@ -874,21 +987,26 @@ mod test {
} }
assert!( assert!(
call_parse_string_to_value!( parse_string_to_value(
"timestamp_col", "timestamp_col",
"2022-02-22T00:01:01+08".to_string(), "2022-02-22T00:01:01+08".to_string(),
ConcreteDataType::timestamp_datatype(TimeUnit::Nanosecond) &ConcreteDataType::timestamp_datatype(TimeUnit::Nanosecond),
None,
false,
) )
.is_err() .is_err()
); );
// with timezone // with timezone
match call_parse_string_to_value!( match parse_string_to_value(
"timestamp_col", "timestamp_col",
"2022-02-22T00:01:01".to_string(), "2022-02-22T00:01:01".to_string(),
ConcreteDataType::timestamp_datatype(TimeUnit::Nanosecond), &ConcreteDataType::timestamp_datatype(TimeUnit::Nanosecond),
timezone = &Timezone::from_tz_string("Asia/Shanghai").unwrap() Some(&Timezone::from_tz_string("Asia/Shanghai").unwrap()),
)? { false,
)
.unwrap()
{
Value::Timestamp(ts) => { Value::Timestamp(ts) => {
assert_eq!(1645459261000000000, ts.value()); assert_eq!(1645459261000000000, ts.value());
assert_eq!("2022-02-21 16:01:01+0000", ts.to_iso8601_string()); assert_eq!("2022-02-21 16:01:01+0000", ts.to_iso8601_string());
@@ -898,42 +1016,51 @@ mod test {
unreachable!() unreachable!()
} }
} }
Ok(())
} }
#[test] #[test]
fn test_parse_placeholder_value() { fn test_parse_placeholder_value() {
assert!( assert!(
call_sql_value_to_value!( sql_value_to_value(
"test", "test",
ConcreteDataType::string_datatype(), &ConcreteDataType::string_datatype(),
&SqlValue::Placeholder("default".into())
)
.is_err()
);
assert!(
call_sql_value_to_value!(
"test",
ConcreteDataType::string_datatype(),
&SqlValue::Placeholder("default".into()), &SqlValue::Placeholder("default".into()),
unary_op = UnaryOperator::Minus None,
None,
false
) )
.is_err() .is_err()
); );
assert!( assert!(
call_sql_value_to_value!( sql_value_to_value(
"test", "test",
ConcreteDataType::uint16_datatype(), &ConcreteDataType::string_datatype(),
&SqlValue::Placeholder("default".into()),
None,
Some(UnaryOperator::Minus),
false
)
.is_err()
);
assert!(
sql_value_to_value(
"test",
&ConcreteDataType::uint16_datatype(),
&SqlValue::Number("3".into(), false), &SqlValue::Number("3".into(), false),
unary_op = UnaryOperator::Minus None,
Some(UnaryOperator::Minus),
false
) )
.is_err() .is_err()
); );
assert!( assert!(
call_sql_value_to_value!( sql_value_to_value(
"test", "test",
ConcreteDataType::uint16_datatype(), &ConcreteDataType::uint16_datatype(),
&SqlValue::Number("3".into(), false) &SqlValue::Number("3".into(), false),
None,
None,
false
) )
.is_ok() .is_ok()
); );
@@ -943,60 +1070,77 @@ mod test {
fn test_auto_string_to_numeric() { fn test_auto_string_to_numeric() {
// Test with auto_string_to_numeric=true // Test with auto_string_to_numeric=true
let sql_val = SqlValue::SingleQuotedString("123".to_string()); let sql_val = SqlValue::SingleQuotedString("123".to_string());
let v = call_sql_value_to_value!( let v = sql_value_to_value(
"a", "a",
ConcreteDataType::int32_datatype(), &ConcreteDataType::int32_datatype(),
&sql_val, &sql_val,
auto_string_to_numeric None,
None,
true,
) )
.unwrap(); .unwrap();
assert_eq!(Value::Int32(123), v); assert_eq!(Value::Int32(123), v);
// Test with a float string // Test with a float string
let sql_val = SqlValue::SingleQuotedString("3.5".to_string()); let sql_val = SqlValue::SingleQuotedString("3.5".to_string());
let v = call_sql_value_to_value!( let v = sql_value_to_value(
"a", "a",
ConcreteDataType::float64_datatype(), &ConcreteDataType::float64_datatype(),
&sql_val, &sql_val,
auto_string_to_numeric None,
None,
true,
) )
.unwrap(); .unwrap();
assert_eq!(Value::Float64(OrderedFloat(3.5)), v); assert_eq!(Value::Float64(OrderedFloat(3.5)), v);
// Test with auto_string_to_numeric=false // Test with auto_string_to_numeric=false
let sql_val = SqlValue::SingleQuotedString("123".to_string()); let sql_val = SqlValue::SingleQuotedString("123".to_string());
let v = call_sql_value_to_value!("a", ConcreteDataType::int32_datatype(), &sql_val); let v = sql_value_to_value(
"a",
&ConcreteDataType::int32_datatype(),
&sql_val,
None,
None,
false,
);
assert!(v.is_err()); assert!(v.is_err());
// Test with an invalid numeric string but auto_string_to_numeric=true // Test with an invalid numeric string but auto_string_to_numeric=true
// Should return an error now with the new auto_cast_to_numeric behavior // Should return an error now with the new auto_cast_to_numeric behavior
let sql_val = SqlValue::SingleQuotedString("not_a_number".to_string()); let sql_val = SqlValue::SingleQuotedString("not_a_number".to_string());
let v = call_sql_value_to_value!( let v = sql_value_to_value(
"a", "a",
ConcreteDataType::int32_datatype(), &ConcreteDataType::int32_datatype(),
&sql_val, &sql_val,
auto_string_to_numeric None,
None,
true,
); );
assert!(v.is_err()); assert!(v.is_err());
// Test with boolean type // Test with boolean type
let sql_val = SqlValue::SingleQuotedString("true".to_string()); let sql_val = SqlValue::SingleQuotedString("true".to_string());
let v = call_sql_value_to_value!( let v = sql_value_to_value(
"a", "a",
ConcreteDataType::boolean_datatype(), &ConcreteDataType::boolean_datatype(),
&sql_val, &sql_val,
auto_string_to_numeric None,
None,
true,
) )
.unwrap(); .unwrap();
assert_eq!(Value::Boolean(true), v); assert_eq!(Value::Boolean(true), v);
// Non-numeric types should still be handled normally // Non-numeric types should still be handled normally
let sql_val = SqlValue::SingleQuotedString("hello".to_string()); let sql_val = SqlValue::SingleQuotedString("hello".to_string());
let v = call_sql_value_to_value!( let v = sql_value_to_value(
"a", "a",
ConcreteDataType::string_datatype(), &ConcreteDataType::string_datatype(),
&sql_val, &sql_val,
auto_string_to_numeric None,
None,
true,
); );
assert!(v.is_ok()); assert!(v.is_ok());
} }

View File

@@ -14,8 +14,8 @@
use common_time::timezone::Timezone; use common_time::timezone::Timezone;
use datatypes::prelude::ConcreteDataType; use datatypes::prelude::ConcreteDataType;
use datatypes::schema::ColumnDefaultConstraint;
use datatypes::schema::constraint::{CURRENT_TIMESTAMP, CURRENT_TIMESTAMP_FN}; use datatypes::schema::constraint::{CURRENT_TIMESTAMP, CURRENT_TIMESTAMP_FN};
use datatypes::schema::{ColumnDefaultConstraint, ColumnSchema};
use snafu::ensure; use snafu::ensure;
use sqlparser::ast::ValueWithSpan; use sqlparser::ast::ValueWithSpan;
pub use sqlparser::ast::{ pub use sqlparser::ast::{
@@ -47,12 +47,9 @@ pub fn parse_column_default_constraint(
); );
let default_constraint = match &opt.option { let default_constraint = match &opt.option {
ColumnOption::Default(Expr::Value(v)) => { ColumnOption::Default(Expr::Value(v)) => ColumnDefaultConstraint::Value(
let schema = ColumnSchema::new(column_name, data_type.clone(), true); sql_value_to_value(column_name, data_type, &v.value, timezone, None, false)?,
ColumnDefaultConstraint::Value(sql_value_to_value( ),
&schema, &v.value, timezone, None, false,
)?)
}
ColumnOption::Default(Expr::Function(func)) => { ColumnOption::Default(Expr::Function(func)) => {
let mut func = format!("{func}").to_lowercase(); let mut func = format!("{func}").to_lowercase();
// normalize CURRENT_TIMESTAMP to CURRENT_TIMESTAMP() // normalize CURRENT_TIMESTAMP to CURRENT_TIMESTAMP()
@@ -83,7 +80,8 @@ pub fn parse_column_default_constraint(
if let Expr::Value(v) = &**expr { if let Expr::Value(v) = &**expr {
let value = sql_value_to_value( let value = sql_value_to_value(
&ColumnSchema::new(column_name, data_type.clone(), true), column_name,
data_type,
&v.value, &v.value,
timezone, timezone,
Some(*op), Some(*op),

View File

@@ -71,7 +71,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}), }),
MetricType::GAUGE => timeseries.push(TimeSeries { MetricType::GAUGE => timeseries.push(TimeSeries {
labels: convert_label(m.get_label(), mf_name, None), labels: convert_label(m.get_label(), mf_name, None),
@@ -80,7 +79,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}), }),
MetricType::HISTOGRAM => { MetricType::HISTOGRAM => {
let h = m.get_histogram(); let h = m.get_histogram();
@@ -99,7 +97,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
if upper_bound.is_sign_positive() && upper_bound.is_infinite() { if upper_bound.is_sign_positive() && upper_bound.is_infinite() {
inf_seen = true; inf_seen = true;
@@ -117,7 +114,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
} }
timeseries.push(TimeSeries { timeseries.push(TimeSeries {
@@ -131,7 +127,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
timeseries.push(TimeSeries { timeseries.push(TimeSeries {
labels: convert_label( labels: convert_label(
@@ -144,7 +139,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
} }
MetricType::SUMMARY => { MetricType::SUMMARY => {
@@ -161,7 +155,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
} }
timeseries.push(TimeSeries { timeseries.push(TimeSeries {
@@ -175,7 +168,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
timeseries.push(TimeSeries { timeseries.push(TimeSeries {
labels: convert_label( labels: convert_label(
@@ -188,7 +180,6 @@ pub fn convert_metric_to_write_request(
timestamp, timestamp,
}], }],
exemplars: vec![], exemplars: vec![],
histograms: vec![],
}); });
} }
MetricType::UNTYPED => { MetricType::UNTYPED => {
@@ -283,7 +274,7 @@ mod test {
assert_eq!( assert_eq!(
format!("{:?}", write_quest.timeseries), format!("{:?}", write_quest.timeseries),
r#"[TimeSeries { labels: [Label { name: "__name__", value: "test_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] }]"# r#"[TimeSeries { labels: [Label { name: "__name__", value: "test_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }]"#
); );
let gauge_opts = Opts::new("test_gauge", "test help") let gauge_opts = Opts::new("test_gauge", "test help")
@@ -297,7 +288,7 @@ mod test {
let write_quest = convert_metric_to_write_request(mf, None, 0); let write_quest = convert_metric_to_write_request(mf, None, 0);
assert_eq!( assert_eq!(
format!("{:?}", write_quest.timeseries), format!("{:?}", write_quest.timeseries),
r#"[TimeSeries { labels: [Label { name: "__name__", value: "test_gauge" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 42.0, timestamp: 0 }], exemplars: [], histograms: [] }]"# r#"[TimeSeries { labels: [Label { name: "__name__", value: "test_gauge" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 42.0, timestamp: 0 }], exemplars: [] }]"#
); );
} }
@@ -314,20 +305,20 @@ mod test {
.iter() .iter()
.map(|x| format!("{:?}", x)) .map(|x| format!("{:?}", x))
.collect(); .collect();
let ans = r#"TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.005" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [], histograms: [] } let ans = r#"TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.005" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.01" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.01" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.025" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.025" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.05" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.05" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.1" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.1" }], samples: [Sample { value: 0.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.25" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.25" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.5" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "0.5" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "1" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "1" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "2.5" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "2.5" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "5" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "5" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "10" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "10" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "+Inf" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_bucket" }, Label { name: "a", value: "1" }, Label { name: "le", value: "+Inf" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_sum" }, Label { name: "a", value: "1" }], samples: [Sample { value: 0.25, timestamp: 0 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_sum" }, Label { name: "a", value: "1" }], samples: [Sample { value: 0.25, timestamp: 0 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_count" }, Label { name: "a", value: "1" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] }"#; TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_count" }, Label { name: "a", value: "1" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }"#;
assert_eq!(write_quest_str.join("\n"), ans); assert_eq!(write_quest_str.join("\n"), ans);
} }
@@ -364,10 +355,10 @@ TimeSeries { labels: [Label { name: "__name__", value: "test_histogram_count" },
.iter() .iter()
.map(|x| format!("{:?}", x)) .map(|x| format!("{:?}", x))
.collect(); .collect();
let ans = r#"TimeSeries { labels: [Label { name: "__name__", value: "test_summary" }, Label { name: "quantile", value: "50" }], samples: [Sample { value: 3.0, timestamp: 20 }], exemplars: [], histograms: [] } let ans = r#"TimeSeries { labels: [Label { name: "__name__", value: "test_summary" }, Label { name: "quantile", value: "50" }], samples: [Sample { value: 3.0, timestamp: 20 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_summary" }, Label { name: "quantile", value: "100" }], samples: [Sample { value: 5.0, timestamp: 20 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_summary" }, Label { name: "quantile", value: "100" }], samples: [Sample { value: 5.0, timestamp: 20 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_summary_sum" }], samples: [Sample { value: 15.0, timestamp: 20 }], exemplars: [], histograms: [] } TimeSeries { labels: [Label { name: "__name__", value: "test_summary_sum" }], samples: [Sample { value: 15.0, timestamp: 20 }], exemplars: [] }
TimeSeries { labels: [Label { name: "__name__", value: "test_summary_count" }], samples: [Sample { value: 5.0, timestamp: 20 }], exemplars: [], histograms: [] }"#; TimeSeries { labels: [Label { name: "__name__", value: "test_summary_count" }], samples: [Sample { value: 5.0, timestamp: 20 }], exemplars: [] }"#;
assert_eq!(write_quest_str.join("\n"), ans); assert_eq!(write_quest_str.join("\n"), ans);
} }
@@ -394,11 +385,11 @@ TimeSeries { labels: [Label { name: "__name__", value: "test_summary_count" }],
let write_quest2 = convert_metric_to_write_request(mf, Some(&filter), 0); let write_quest2 = convert_metric_to_write_request(mf, Some(&filter), 0);
assert_eq!( assert_eq!(
format!("{:?}", write_quest1.timeseries), format!("{:?}", write_quest1.timeseries),
r#"[TimeSeries { labels: [Label { name: "__name__", value: "filter_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [], histograms: [] }, TimeSeries { labels: [Label { name: "__name__", value: "test_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 2.0, timestamp: 0 }], exemplars: [], histograms: [] }]"# r#"[TimeSeries { labels: [Label { name: "__name__", value: "filter_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 1.0, timestamp: 0 }], exemplars: [] }, TimeSeries { labels: [Label { name: "__name__", value: "test_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 2.0, timestamp: 0 }], exemplars: [] }]"#
); );
assert_eq!( assert_eq!(
format!("{:?}", write_quest2.timeseries), format!("{:?}", write_quest2.timeseries),
r#"[TimeSeries { labels: [Label { name: "__name__", value: "test_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 2.0, timestamp: 0 }], exemplars: [], histograms: [] }]"# r#"[TimeSeries { labels: [Label { name: "__name__", value: "test_counter" }, Label { name: "a", value: "1" }, Label { name: "b", value: "2" }], samples: [Sample { value: 2.0, timestamp: 0 }], exemplars: [] }]"#
); );
} }
} }

View File

@@ -206,8 +206,6 @@ mod tests {
client_cert_path: None, client_cert_path: None,
client_key_path: None, client_key_path: None,
}), }),
connect_timeout: Duration::from_secs(3),
timeout: Duration::from_secs(3),
}, },
kafka_topic: KafkaTopicConfig { kafka_topic: KafkaTopicConfig {
num_topics: 32, num_topics: 32,
@@ -241,8 +239,6 @@ mod tests {
client_cert_path: None, client_cert_path: None,
client_key_path: None, client_key_path: None,
}), }),
connect_timeout: Duration::from_secs(3),
timeout: Duration::from_secs(3),
}, },
max_batch_bytes: ReadableSize::mb(1), max_batch_bytes: ReadableSize::mb(1),
consumer_wait_timeout: Duration::from_millis(100), consumer_wait_timeout: Duration::from_millis(100),

View File

@@ -36,6 +36,9 @@ pub const DEFAULT_BACKOFF_CONFIG: BackoffConfig = BackoffConfig {
deadline: Some(Duration::from_secs(3)), deadline: Some(Duration::from_secs(3)),
}; };
/// The default connect timeout for kafka client.
pub const DEFAULT_CONNECT_TIMEOUT: Duration = Duration::from_secs(10);
/// Default interval for auto WAL pruning. /// Default interval for auto WAL pruning.
pub const DEFAULT_AUTO_PRUNE_INTERVAL: Duration = Duration::from_mins(30); pub const DEFAULT_AUTO_PRUNE_INTERVAL: Duration = Duration::from_mins(30);
/// Default limit for concurrent auto pruning tasks. /// Default limit for concurrent auto pruning tasks.
@@ -164,12 +167,6 @@ pub struct KafkaConnectionConfig {
pub sasl: Option<KafkaClientSasl>, pub sasl: Option<KafkaClientSasl>,
/// Client TLS config /// Client TLS config
pub tls: Option<KafkaClientTls>, pub tls: Option<KafkaClientTls>,
/// The connect timeout for kafka client.
#[serde(with = "humantime_serde")]
pub connect_timeout: Duration,
/// The timeout for kafka client.
#[serde(with = "humantime_serde")]
pub timeout: Duration,
} }
impl Default for KafkaConnectionConfig { impl Default for KafkaConnectionConfig {
@@ -178,8 +175,6 @@ impl Default for KafkaConnectionConfig {
broker_endpoints: vec![BROKER_ENDPOINT.to_string()], broker_endpoints: vec![BROKER_ENDPOINT.to_string()],
sasl: None, sasl: None,
tls: None, tls: None,
connect_timeout: Duration::from_secs(3),
timeout: Duration::from_secs(3),
} }
} }
} }

Some files were not shown because too many files have changed in this diff Show More