Skip to content

API Documentation

Comprehensive Javadoc API documentation for all classes and methods in General SQL Parser.

Browse the Full Javadoc API Reference

API Access

The Javadoc is generated automatically from the source code and includes detailed descriptions of all public classes, methods, and fields.

Key Packages

While the full Javadoc provides exhaustive details, here are some of the most commonly used packages:

  • gudusoft.gsqlparser: Core parser classes, including TGSqlParser.
  • gudusoft.gsqlparser.nodes: Abstract Syntax Tree (AST) nodes representing SQL elements.
  • gudusoft.gsqlparser.stmt: Specific SQL statement classes such as TSelectSqlStatement.
  • gudusoft.gsqlparser.util: Utility classes for working with the parser.
  • gudusoft.gsqlparser.ir.semantic: SqlSemanticAnalyzer, immutable analysis results, structured diagnostics, and the Semantic IR read model.
  • gudusoft.gsqlparser.ir.semantic.joinanalysis: Supported read-only join graph, predicates, endpoints, query-block scopes, and provenance.
  • gudusoft.gsqlparser.ir.semantic.catalog: Supported catalog input DTOs for metadata-backed semantic analysis.

Semantic IR API tiers

The supported Join Analysis Consumption Profile v1 starts at SqlSemanticAnalyzer and reads immutable results through AnalysisResult, SemanticProgram, StatementGraph, and the joinanalysis types. See the Join analysis guide for an executable example, compatibility rules, catalog behavior, and diagnostic handling.

The wider Semantic IR source tree also contains advanced/preview builder and binding APIs and internal validation/parity packages. Public Java visibility is not, by itself, a compatibility designation. Each package and primary type is labeled in its Javadoc; prefer the analyzer profile unless you deliberately own the parser, resolver, recovery, and schema-version responsibilities.

Using the Javadoc

  • Overview: Start with the Overview page for a summary of all packages.
  • Package: Select a package to see its classes and interfaces.
  • Class/Interface: View detailed descriptions, member summaries, and method details.
  • Search: Use the search bar in the Javadoc to find specific classes or methods.

Refer to the full Javadoc for complete API details.