Files
s3/weed/query/engine/describe.go
zooqueen dd74d3e6d6 Replace AGPL MinIO fork with Apache-2.0 SeaweedFS fork; rebrand CLI weed->s3
hanzoai/s3 was an AGPL-3.0 MinIO fork whose network-copyleft blocks embedding
and reselling as a managed service. Replace it wholesale with a fork of
SeaweedFS (github.com/seaweedfs/seaweedfs, Apache-2.0, Go) which ships a
built-in S3 gateway + Filer.

- License: AGPL-3.0 -> Apache-2.0 (upstream LICENSE kept verbatim, incl.
  "Copyright 2025 Chris Lu"); NOTICE added crediting SeaweedFS. No AGPL/BUSL/
  SSPL/GPL or enterprise ("ee") files remain.
- Module: go.mod path set to github.com/hanzoai/s3 with a self-replace
  (replace github.com/seaweedfs/seaweedfs => ./) so the ~1800 internal Go files
  keep their upstream import paths with zero churn. Internal identifiers and
  import paths are intentionally NOT renamed.
- CLI rebrand: the binary is built as `s3` (was `weed`); root usage, per-command
  help/usage/flag strings, shell autocomplete program name, and the product name
  in CLI output now read "Hanzo S3" / `s3`. Users never see `weed`.
  (e.g. `s3 server`, `s3 filer`, `s3 master`, `s3 volume`, `s3 s3`, `s3 mount`.)
- Build: `make` (or `go build -o s3 ./weed`) builds the `s3` binary green;
  `cmd/weed-db` and `cmd/weed-sql` also build; `go vet ./weed/command/` clean.
- README/LLM.md rewritten for Hanzo S3; AGENTS.md/CLAUDE.md symlinks preserved.
- Dropped a 33MB prebuilt Mach-O `stress` binary upstream had committed; `.gitignore`
  updated to ignore the `s3` build output.
2026-06-18 23:41:25 -07:00

167 lines
4.8 KiB
Go

package engine
import (
"context"
"fmt"
"strings"
"github.com/seaweedfs/seaweedfs/weed/query/sqltypes"
)
// executeDescribeStatement handles DESCRIBE table commands
// Shows table schema in PostgreSQL-compatible format
func (e *SQLEngine) executeDescribeStatement(ctx context.Context, tableName string, database string) (*QueryResult, error) {
if database == "" {
database = e.catalog.GetCurrentDatabase()
if database == "" {
database = "default"
}
}
// Auto-discover and register topic if not already in catalog (same logic as SELECT)
if _, err := e.catalog.GetTableInfo(database, tableName); err != nil {
// Topic not in catalog, try to discover and register it
if regErr := e.discoverAndRegisterTopic(ctx, database, tableName); regErr != nil {
fmt.Printf("Warning: Failed to discover topic %s.%s: %v\n", database, tableName, regErr)
return &QueryResult{Error: fmt.Errorf("topic %s.%s not found and auto-discovery failed: %v", database, tableName, regErr)}, regErr
}
}
// Get flat schema and key columns from broker
flatSchema, keyColumns, _, err := e.catalog.brokerClient.GetTopicSchema(ctx, database, tableName)
if err != nil {
return &QueryResult{Error: err}, err
}
// System columns to include in DESCRIBE output
systemColumns := []struct {
Name string
Type string
Extra string
}{
{"_ts", "TIMESTAMP", "System column: Message timestamp"},
{"_key", "VARBINARY", "System column: Message key"},
{"_source", "VARCHAR(255)", "System column: Data source (parquet/log)"},
}
// If no schema is defined, include _value field
if flatSchema == nil {
systemColumns = append(systemColumns, struct {
Name string
Type string
Extra string
}{SW_COLUMN_NAME_VALUE, "VARBINARY", "Raw message value (no schema defined)"})
}
// Calculate total rows: schema fields + system columns
totalRows := len(systemColumns)
if flatSchema != nil {
totalRows += len(flatSchema.Fields)
}
// Create key column lookup map
keyColumnMap := make(map[string]bool)
for _, keyCol := range keyColumns {
keyColumnMap[keyCol] = true
}
result := &QueryResult{
Columns: []string{"Field", "Type", "Null", "Key", "Default", "Extra"},
Rows: make([][]sqltypes.Value, totalRows),
}
rowIndex := 0
// Add schema fields - mark key columns appropriately
if flatSchema != nil {
for _, field := range flatSchema.Fields {
sqlType := e.convertMQTypeToSQL(field.Type)
isKey := keyColumnMap[field.Name]
keyType := ""
if isKey {
keyType = "PRI" // Primary key
}
extra := "Data field"
if isKey {
extra = "Key field"
}
result.Rows[rowIndex] = []sqltypes.Value{
sqltypes.NewVarChar(field.Name),
sqltypes.NewVarChar(sqlType),
sqltypes.NewVarChar("YES"),
sqltypes.NewVarChar(keyType),
sqltypes.NewVarChar("NULL"),
sqltypes.NewVarChar(extra),
}
rowIndex++
}
}
// Add system columns
for _, sysCol := range systemColumns {
result.Rows[rowIndex] = []sqltypes.Value{
sqltypes.NewVarChar(sysCol.Name), // Field
sqltypes.NewVarChar(sysCol.Type), // Type
sqltypes.NewVarChar("YES"), // Null
sqltypes.NewVarChar("SYS"), // Key - mark as system column
sqltypes.NewVarChar("NULL"), // Default
sqltypes.NewVarChar(sysCol.Extra), // Extra - description
}
rowIndex++
}
return result, nil
}
// Enhanced executeShowStatementWithDescribe handles SHOW statements including DESCRIBE
func (e *SQLEngine) executeShowStatementWithDescribe(ctx context.Context, stmt *ShowStatement) (*QueryResult, error) {
switch strings.ToUpper(stmt.Type) {
case "DATABASES":
return e.showDatabases(ctx)
case "TABLES":
// Parse FROM clause for database specification, or use current database context
database := ""
// Check if there's a database specified in SHOW TABLES FROM database
if stmt.Schema != "" {
// Use schema field if set by parser
database = stmt.Schema
} else {
// Try to get from OnTable.Name with proper nil checks
if stmt.OnTable.Name != nil {
if nameStr := stmt.OnTable.Name.String(); nameStr != "" {
database = nameStr
} else {
database = e.catalog.GetCurrentDatabase()
}
} else {
database = e.catalog.GetCurrentDatabase()
}
}
if database == "" {
// Use current database context
database = e.catalog.GetCurrentDatabase()
}
return e.showTables(ctx, database)
case "COLUMNS":
// SHOW COLUMNS FROM table is equivalent to DESCRIBE
var tableName, database string
// Safely extract table name and database with proper nil checks
if stmt.OnTable.Name != nil {
tableName = stmt.OnTable.Name.String()
if stmt.OnTable.Qualifier != nil {
database = stmt.OnTable.Qualifier.String()
}
}
if tableName != "" {
return e.executeDescribeStatement(ctx, tableName, database)
}
fallthrough
default:
err := fmt.Errorf("unsupported SHOW statement: %s", stmt.Type)
return &QueryResult{Error: err}, err
}
}