Skip to content

feat(cbinding,python): dialect-aware exports, lint, security scan, transpile (pygosqlx 0.3.0) #850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ajitpratap0 merged 4 commits into from
Oct 22, 2026
Merged

feat(cbinding,python): dialect-aware exports, lint, security scan, transpile (pygosqlx 0.3.0) #850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e8e3aa
feat(cbinding,python): dialect-aware exports, lint, security scan, tr…
Oct 21, 2026
b52dadd
fix(cbinding): avoid deprecated SingleLineLimit in dialect format path
Oct 21, 2026
2f3add0
Merge branch 'main' into feat/pygosqlx-0.3.0-api
ajitpratap0 Oct 21, 2026
ee7646e
fix(cbinding): reject trailing ']'/'}' after lint options; require tr…
Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ linter → sql/parser, sql/tokenizer
# rule sub-packages additionally import: linter, models, sql/ast
highlight → models, errors, sql/keywords, sql/tokenizer
lsp → errors, models, gosqlx, sql/keywords, sql/parser, sql/tokenizer
cbinding → gosqlx, sql/ast (requires CGO; excluded from task test:race)
cbinding → gosqlx, errors, formatter, linter (+ rule sub-packages), sql/ast,
sql/keywords, sql/parser, sql/security
(requires CGO; excluded from task test:race)

# High-level wrapper
gosqlx → all of the above (top-level convenience API)
Expand Down
2 changes: 1 addition & 1 deletion pkg/cbinding/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ echo " Header: $OUTPUT_DIR/libgosqlx.h"
echo ""
echo "To use with Python:"
echo " export GOSQLX_LIB_PATH=$OUTPUT_DIR/libgosqlx.${EXT}"
echo " python -c 'import pygosqlx; print(pygosqlx.version())'"
echo " python -c 'import pygosqlx; print(pygosqlx.version(), pygosqlx.dialects())'"
196 changes: 47 additions & 149 deletions pkg/cbinding/cbinding.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,33 @@
// gosqlx_extract_metadata(sql) - extract tables, columns, functions with schema qualification
// gosqlx_version() - return the library version string (e.g. "1.10.0")
// gosqlx_free(ptr) - free a string previously returned by any gosqlx_* function
//
// Dialect-aware and analysis exports (added for pygosqlx 0.3.0; see cbinding_ext.go):
//
// gosqlx_parse_dialect(sql, dialect) - gosqlx_parse with a SQL dialect
// gosqlx_validate_dialect(sql, dialect) - gosqlx_validate with a SQL dialect
// gosqlx_format_dialect(sql, dialect) - gosqlx_format with a SQL dialect
// gosqlx_extract_tables_dialect(sql, dialect) - gosqlx_extract_tables with a SQL dialect
// gosqlx_extract_columns_dialect(sql, dialect) - gosqlx_extract_columns with a SQL dialect
// gosqlx_extract_functions_dialect(sql, dialect) - gosqlx_extract_functions with a SQL dialect
// gosqlx_extract_metadata_dialect(sql, dialect) - gosqlx_extract_metadata with a SQL dialect
// gosqlx_lint(sql, options_json) - run the `gosqlx lint` rule set (L001-L010)
// gosqlx_security_scan(sql) - scan SQL for injection patterns
// gosqlx_transpile(sql, from, to) - convert SQL between dialects
// gosqlx_dialects() - list the accepted dialect names
//
// The *_dialect variants take the dialect as a plain C string rather than an
// options JSON object: a dialect is the only option those operations accept, so
// a second string argument keeps the ABI as simple as the original exports. A
// NULL or empty dialect behaves exactly like the original export. An unknown
// dialect yields the operation's normal error shape with "error_code" set to
// "E4002" (pkg/errors.ErrCodeUnsupportedDialect) and the error message listing
// the valid names from gosqlx_dialects. Exports that genuinely take several
// options (gosqlx_lint) accept an options JSON object instead.
//
// The original exports are ABI-stable: their names, signatures and JSON output
// are unchanged. New fields are only ever added with omitempty so existing
// consumers see byte-identical results.
package main

// #include <stdlib.h>
Expand Down Expand Up @@ -66,6 +93,8 @@ type ParseResult struct {
ErrorColumn int `json:"error_column,omitempty"`
StmtCount int `json:"statement_count"`
StmtTypes []string `json:"statement_types"`
// ErrorCode is set only by the *_dialect exports for an unknown dialect.
ErrorCode string `json:"error_code,omitempty"`
}

// ValidationResult represents the result of validating SQL.
Expand All @@ -74,13 +103,17 @@ type ValidationResult struct {
Error string `json:"error,omitempty"`
ErrorLine int `json:"error_line,omitempty"`
ErrorColumn int `json:"error_column,omitempty"`
// ErrorCode is set only by the *_dialect exports for an unknown dialect.
ErrorCode string `json:"error_code,omitempty"`
}

// FormatResult represents the result of formatting SQL.
type FormatResult struct {
Success bool `json:"success"`
Formatted string `json:"formatted,omitempty"`
Error string `json:"error,omitempty"`
// ErrorCode is set only by the *_dialect exports for an unknown dialect.
ErrorCode string `json:"error_code,omitempty"`
}

// QualifiedNameJSON represents a qualified name for JSON serialization.
Expand All @@ -98,6 +131,8 @@ type MetadataResult struct {
ColumnsQualified []QualifiedNameJSON `json:"columns_qualified"`
Functions []string `json:"functions"`
Error string `json:"error,omitempty"`
// ErrorCode is set only by the *_dialect exports for an unknown dialect.
ErrorCode string `json:"error_code,omitempty"`
}

// extractErrorPosition extracts line and column numbers from an error message string.
Expand Down Expand Up @@ -173,31 +208,7 @@ func statementTypeName(stmt ast.Statement) string {
//
//export gosqlx_parse
func gosqlx_parse(sql *C.char) *C.char {
goSQL := C.GoString(sql)

tree, err := gosqlx.Parse(goSQL)
if err != nil {
line, col := extractErrorPosition(err.Error())
result := ParseResult{
Success: false,
Error: err.Error(),
ErrorLine: line,
ErrorColumn: col,
}
return toJSON(result)
}

stmtTypes := make([]string, 0, len(tree.Statements))
for _, stmt := range tree.Statements {
stmtTypes = append(stmtTypes, statementTypeName(stmt))
}

result := ParseResult{
Success: true,
StmtCount: len(tree.Statements),
StmtTypes: stmtTypes,
}
return toJSON(result)
return toJSON(parseResultFor(C.GoString(sql), ""))
}

// gosqlx_validate validates a SQL string for syntactic correctness and returns
Expand All @@ -212,22 +223,7 @@ func gosqlx_parse(sql *C.char) *C.char {
//
//export gosqlx_validate
func gosqlx_validate(sql *C.char) *C.char {
goSQL := C.GoString(sql)

err := gosqlx.Validate(goSQL)
if err != nil {
line, col := extractErrorPosition(err.Error())
result := ValidationResult{
Valid: false,
Error: err.Error(),
ErrorLine: line,
ErrorColumn: col,
}
return toJSON(result)
}

result := ValidationResult{Valid: true}
return toJSON(result)
return toJSON(validationResultFor(C.GoString(sql), ""))
}

// gosqlx_format formats a SQL string using default formatting options and
Expand All @@ -242,23 +238,7 @@ func gosqlx_validate(sql *C.char) *C.char {
//
//export gosqlx_format
func gosqlx_format(sql *C.char) *C.char {
goSQL := C.GoString(sql)

opts := gosqlx.DefaultFormatOptions()
formatted, err := gosqlx.Format(goSQL, opts)
if err != nil {
result := FormatResult{
Success: false,
Error: err.Error(),
}
return toJSON(result)
}

result := FormatResult{
Success: true,
Formatted: formatted,
}
return toJSON(result)
return toJSON(formatResultFor(C.GoString(sql), ""))
}

// gosqlx_extract_tables parses a SQL string and extracts all referenced table
Expand All @@ -273,18 +253,7 @@ func gosqlx_format(sql *C.char) *C.char {
//
//export gosqlx_extract_tables
func gosqlx_extract_tables(sql *C.char) *C.char {
goSQL := C.GoString(sql)

tree, err := gosqlx.Parse(goSQL)
if err != nil {
return toJSON(map[string]interface{}{"error": err.Error()})
}

tables := gosqlx.ExtractTables(tree)
if tables == nil {
tables = []string{}
}
return toJSON(map[string]interface{}{"tables": tables})
return toJSON(extractListFor(C.GoString(sql), "", "tables", gosqlx.ExtractTables))
}

// gosqlx_extract_columns parses a SQL string and extracts all referenced column
Expand All @@ -299,18 +268,7 @@ func gosqlx_extract_tables(sql *C.char) *C.char {
//
//export gosqlx_extract_columns
func gosqlx_extract_columns(sql *C.char) *C.char {
goSQL := C.GoString(sql)

tree, err := gosqlx.Parse(goSQL)
if err != nil {
return toJSON(map[string]interface{}{"error": err.Error()})
}

columns := gosqlx.ExtractColumns(tree)
if columns == nil {
columns = []string{}
}
return toJSON(map[string]interface{}{"columns": columns})
return toJSON(extractListFor(C.GoString(sql), "", "columns", gosqlx.ExtractColumns))
}

// gosqlx_extract_functions parses a SQL string and extracts all referenced
Expand All @@ -325,18 +283,7 @@ func gosqlx_extract_columns(sql *C.char) *C.char {
//
//export gosqlx_extract_functions
func gosqlx_extract_functions(sql *C.char) *C.char {
goSQL := C.GoString(sql)

tree, err := gosqlx.Parse(goSQL)
if err != nil {
return toJSON(map[string]interface{}{"error": err.Error()})
}

functions := gosqlx.ExtractFunctions(tree)
if functions == nil {
functions = []string{}
}
return toJSON(map[string]interface{}{"functions": functions})
return toJSON(extractListFor(C.GoString(sql), "", "functions", gosqlx.ExtractFunctions))
}

// gosqlx_extract_metadata parses a SQL string and extracts comprehensive
Expand All @@ -351,65 +298,16 @@ func gosqlx_extract_functions(sql *C.char) *C.char {
//
//export gosqlx_extract_metadata
func gosqlx_extract_metadata(sql *C.char) *C.char {
goSQL := C.GoString(sql)

tree, err := gosqlx.Parse(goSQL)
if err != nil {
return toJSON(map[string]interface{}{"error": err.Error()})
}

metadata := gosqlx.ExtractMetadata(tree)

// Convert qualified tables
tablesQualified := make([]QualifiedNameJSON, 0, len(metadata.TablesQualified))
for _, tq := range metadata.TablesQualified {
tablesQualified = append(tablesQualified, QualifiedNameJSON{
Schema: tq.Schema,
Table: tq.Table,
Name: tq.Name,
})
}

// Convert qualified columns
columnsQualified := make([]QualifiedNameJSON, 0, len(metadata.ColumnsQualified))
for _, cq := range metadata.ColumnsQualified {
columnsQualified = append(columnsQualified, QualifiedNameJSON{
Schema: cq.Schema,
Table: cq.Table,
Name: cq.Name,
})
}

// Ensure non-nil slices for consistent JSON output
tables := metadata.Tables
if tables == nil {
tables = []string{}
}
columns := metadata.Columns
if columns == nil {
columns = []string{}
}
functions := metadata.Functions
if functions == nil {
functions = []string{}
}

result := MetadataResult{
Tables: tables,
TablesQualified: tablesQualified,
Columns: columns,
ColumnsQualified: columnsQualified,
Functions: functions,
}
return toJSON(result)
return toJSON(metadataFor(C.GoString(sql), ""))
}

// gosqlx_free releases memory allocated by the C binding functions.
// Passing NULL is a no-op (free(NULL) is defined by the C standard).
// Every C string returned by gosqlx_parse, gosqlx_validate, gosqlx_format,
// gosqlx_extract_tables, gosqlx_extract_columns, gosqlx_extract_functions,
// gosqlx_extract_metadata, and gosqlx_version must be freed with this function
// to avoid memory leaks.
// Every C string returned by any other gosqlx_* export (gosqlx_parse,
// gosqlx_validate, gosqlx_format, the gosqlx_extract_* functions, every
// *_dialect variant, gosqlx_lint, gosqlx_security_scan, gosqlx_transpile,
// gosqlx_dialects and gosqlx_version) must be freed exactly once with this
// function to avoid memory leaks.
//
// Parameters:
// - ptr: a C string pointer previously returned by a gosqlx_* function.
Expand Down
Loading
Loading