feat: add db-schema subcommand for exporting database schema SQL

lib/db_schema.sh

@@ -0,0 +1,237 @@
+#!/bin/bash
+
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+# 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.
+
+# Database Schema Export Module
+# Exports full schema SQL for a given Nacos version and database type
+
+# Supported database types
+DB_SCHEMA_SUPPORTED_TYPES=("mysql" "postgresql")
+
+# Cache directory for downloaded schema files
+DB_SCHEMA_CACHE_DIR="${NACOS_CACHE_DIR:-$HOME/.nacos/cache}"
+
+# ============================================================================
+# Schema File Name Mapping
+# ============================================================================
+
+# Map db_type to the actual schema file name used in Nacos repository.
+# PostgreSQL uses "pg-schema.sql" not "postgresql-schema.sql".
+_schema_filename() {
+    local db_type="$1"
+    case "$db_type" in
+        postgresql) echo "pg-schema.sql" ;;
+        *)          echo "${db_type}-schema.sql" ;;
+    esac
+}
+
+# ============================================================================
+# Validation
+# ============================================================================
+
+validate_db_type() {
+    local db_type="$1"
+    if [ -z "$db_type" ]; then
+        print_error "Database type is required" >&2
+        return 1
+    fi
+    for supported in "${DB_SCHEMA_SUPPORTED_TYPES[@]}"; do
+        if [ "$db_type" = "$supported" ]; then
+            return 0
+        fi
+    done
+    print_error "Unsupported database type: $db_type" >&2
+    print_info "Supported types: ${DB_SCHEMA_SUPPORTED_TYPES[*]}" >&2
+    return 1
+}
+
+# ============================================================================
+# Local Schema Lookup
+# ============================================================================
+
+# Find schema file from a local Nacos installation.
+# Uses NACOS_INSTALL_BASE env var if set (for testing), otherwise $HOME/.nacos/nacos-server-$VERSION.
+# Outputs the file path to stdout if found, empty otherwise.
+find_local_schema() {
+    local version="$1"
+    local db_type="$2"
+    local nacos_home="${NACOS_INSTALL_BASE:-$HOME/.nacos/nacos-server-$version}/nacos"
+    local filename
+    filename=$(_schema_filename "$db_type")
+
+    # New-style: plugin-ext directory (Nacos >3.1.1)
+    local new_path="$nacos_home/plugin-ext/nacos-datasource-plugin-${db_type}/${filename}"
+    if [ -f "$new_path" ]; then
+        echo "$new_path"
+        return 0
+    fi
+
+    # Old-style: conf directory (Nacos <=3.1.1)
+    local old_path="$nacos_home/conf/${filename}"
+    if [ -f "$old_path" ]; then
+        echo "$old_path"
+        return 0
+    fi
+
+    return 1
+}
+
+# ============================================================================
+# Remote Schema Download
+# ============================================================================
+
+# Returns the cache file path for a given version and type.
+_schema_cache_path() {
+    local version="$1"
+    local db_type="$2"
+    echo "${DB_SCHEMA_CACHE_DIR}/${version}-${db_type}-schema.sql"
+}
+
+# Build the GitHub raw URL for a schema file.
+# Tries new plugin path first, falls back to old distribution/conf path.
+_schema_github_urls() {
+    local version="$1"
+    local db_type="$2"
+    local filename
+    filename=$(_schema_filename "$db_type")
+    # New path (Nacos >=3.2.0, after plugin refactor)
+    echo "https://raw.githubusercontent.com/alibaba/nacos/${version}/plugin-default-impl/nacos-default-datasource-plugin/nacos-datasource-plugin-${db_type}/src/main/resources/META-INF/${filename}"
+    # Old path (Nacos <3.2.0)
+    echo "https://raw.githubusercontent.com/alibaba/nacos/${version}/distribution/conf/${filename}"
+}
+
+# Download schema from GitHub with new-path-first fallback.
+# Caches the result. Outputs the local file path on success.
+download_schema() {
+    local version="$1"
+    local db_type="$2"
+
+    # Check cache first
+    local cache_file
+    cache_file=$(_schema_cache_path "$version" "$db_type")
+    if [ -f "$cache_file" ] && [ -s "$cache_file" ]; then
+        print_info "Using cached schema: $cache_file" >&2
+        echo "$cache_file"
+        return 0
+    fi
+
+    mkdir -p "$DB_SCHEMA_CACHE_DIR" 2>/dev/null
+
+    # Try each URL in order
+    local urls
+    urls=$(_schema_github_urls "$version" "$db_type")
+    while IFS= read -r url; do
+        print_info "Downloading schema from: $url" >&2
+        if curl -sSL --fail "$url" -o "$cache_file" 2>/dev/null; then
+            if [ -s "$cache_file" ]; then
+                print_info "Schema cached to: $cache_file" >&2
+                echo "$cache_file"
+                return 0
+            fi
+        fi
+        rm -f "$cache_file"
+    done <<< "$urls"
+
+    print_error "Failed to download schema for Nacos $version ($db_type)" >&2
+    print_info "Check that version tag '$version' exists at https://github.com/alibaba/nacos" >&2
+    return 1
+}
+
+# ============================================================================
+# Interactive Prompts
+# ============================================================================
+
+# Prompt user to select database type interactively.
+# Only works when stdin is a terminal. Outputs selected type to stdout.
+_prompt_db_type() {
+    if [ ! -t 0 ]; then
+        print_error "Database type (--type) is required in non-interactive mode" >&2
+        return 1
+    fi
+    echo "Select database type:" >&2
+    echo "  1. MySQL" >&2
+    echo "  2. PostgreSQL" >&2
+    read -p "Enter choice (1/2): " -r choice
+    case "$choice" in
+        1) echo "mysql" ;;
+        2) echo "postgresql" ;;
+        *)
+            print_error "Invalid choice: $choice" >&2
+            return 1
+            ;;
+    esac
+}
+
+# Prompt user to enter version interactively.
+_prompt_version() {
+    if [ ! -t 0 ]; then
+        print_error "Version (--version/-v) is required in non-interactive mode" >&2
+        return 1
+    fi
+    read -p "Enter Nacos version: " -r version
+    if [ -z "$version" ]; then
+        print_error "Version cannot be empty" >&2
+        return 1
+    fi
+    echo "$version"
+}
+
+# ============================================================================
+# Main Entry Point
+# ============================================================================
+
+# Main function called from nacos-setup.sh.
+# Args: version (optional), db_type (optional)
+# Outputs schema SQL to stdout, all logs to stderr.
+db_schema_main() {
+    local version="$1"
+    local db_type="$2"
+
+    # Resolve missing arguments via interactive prompts
+    if [ -z "$db_type" ]; then
+        db_type=$(_prompt_db_type) || return 1
+    fi
+
+    if [ -z "$version" ]; then
+        # Try to detect locally installed version
+        local installed_dir="$HOME/.nacos"
+        local detected_version=""
+        if [ -d "$installed_dir" ]; then
+            detected_version=$(ls -d "$installed_dir"/nacos-server-*/ 2>/dev/null | sort -V | tail -1 | sed 's|.*/nacos-server-||;s|/||')
+        fi
+        if [ -n "$detected_version" ]; then
+            print_info "Detected installed version: $detected_version" >&2
+            version="$detected_version"
+        else
+            version=$(_prompt_version) || return 1
+        fi
+    fi
+
+    # Validate
+    validate_db_type "$db_type" || return 1
+
+    print_info "Exporting $db_type schema for Nacos $version..." >&2
+
+    # Try local first
+    local schema_file
+    schema_file=$(find_local_schema "$version" "$db_type" 2>/dev/null) || true
+
+    # Fallback to download
+    if [ -z "$schema_file" ]; then
+        schema_file=$(download_schema "$version" "$db_type") || return 1
+    fi
+
+    # Output SQL to stdout
+    cat "$schema_file"
+}

nacos-setup.sh

@@ -146,6 +146,10 @@ DB_CONF_MODE=""
 DB_CONF_FILE=""
 DB_CONF_ACTION=""
 
+# Database schema export mode
+DB_SCHEMA_MODE=false
+DB_SCHEMA_TYPE=""
+
 # ============================================================================
 # Usage Information
 # ============================================================================
@@ -174,6 +178,7 @@ COMMON OPTIONS:
     -db-conf [NAME]               Use external datasource (default: default)
     db-conf edit [NAME]           Edit datasource configuration
     db-conf show [NAME]           Show datasource configuration
+    db-schema [-v VERSION] [--type TYPE]  Export database schema SQL to stdout
     -h, --help                     Show this help message
 
 STANDALONE MODE OPTIONS:
@@ -224,6 +229,16 @@ EXAMPLES:
     # Configure global database settings
     bash nacos-setup.sh --datasource-conf
 
+  Database Schema:
+    # Export MySQL schema for version 3.2.0
+    bash nacos-setup.sh db-schema -v 3.2.0 --type mysql
+
+    # Export and pipe directly to database
+    bash nacos-setup.sh db-schema -v 3.2.0 --type mysql | mysql -h localhost -u root -p nacos
+
+    # Interactive mode (prompts for version and type)
+    bash nacos-setup.sh db-schema
+
 VERSION REQUIREMENTS:
     - Minimum supported: Nacos 2.4.0
     - Nacos 3.x requires Java 17+
@@ -286,6 +301,36 @@ parse_arguments() {
                     exit 1
                 fi
                 ;;
+            db-schema)
+                DB_SCHEMA_MODE=true
+                shift
+                # Parse db-schema specific options
+                while [[ $# -gt 0 ]]; do
+                    case $1 in
+                        -v|--version)
+                            if [ -z "$2" ] || [[ "$2" == -* ]]; then
+                                print_error "db-schema: -v/--version requires a version number"
+                                exit 1
+                            fi
+                            VERSION="$2"
+                            USER_SPECIFIED_VERSION=true
+                            shift 2
+                            ;;
+                        -t|--type)
+                            if [ -z "$2" ] || [[ "$2" == -* ]]; then
+                                print_error "db-schema: --type requires a database type (mysql/postgresql)"
+                                exit 1
+                            fi
+                            DB_SCHEMA_TYPE="$2"
+                            shift 2
+                            ;;
+                        *)
+                            print_error "Unknown db-schema option: $1"
+                            exit 1
+                            ;;
+                    esac
+                done
+                ;;
             --adv)
                 ADVANCED_MODE=true
                 shift
@@ -489,6 +534,17 @@ main() {
         esac
     fi
 
+    # Handle db-schema mode (local mode, doesn't need version fetching or Java)
+    if [ "$DB_SCHEMA_MODE" = true ]; then
+        source "$LIB_DIR/db_schema.sh"
+        local schema_version=""
+        if [ "$USER_SPECIFIED_VERSION" = true ]; then
+            schema_version="$VERSION"
+        fi
+        db_schema_main "$schema_version" "$DB_SCHEMA_TYPE"
+        exit $?
+    fi
+
     # Initialize version (fetch from remote only if user didn't specify -v)
     init_version
     echo ""

tests/run_all.sh

@@ -26,6 +26,7 @@ test_cases=(
     "test_java.sh:Java Environment"
     "test_download.sh:Download & Cache"
     "test_dbconf.sh:--db-conf Feature"
+    "test_db_schema.sh:db-schema Feature"
     "test_package.sh:Package Script"
     "test_bugs.sh:Bug Verification"
     "test_install_paths.sh:Install Path Constants"