Skip to content

API Reference

The full API reference for the .NET library is generated by DocFX directly from the XML documentation comments on gudusoft.gsqlparser.dll.

Browse the API Reference ->

Where it lives

The DocFX site is published alongside this MkDocs site under apidocs/ on the documentation host. If you are reading this offline, the equivalent path is site/apidocs/index.html after running docfx build and mkdocs build.

Key namespaces

The API reference covers the entire gudusoft.gsqlparser namespace tree. The most commonly used namespaces are:

Namespace Contents
gudusoft.gsqlparser Core entry point — TGSqlParser, EDbVendor, ESqlStatementType, TSyntaxError, lexer/parser drivers
gudusoft.gsqlparser.nodes AST node classes (TParseTreeNode and subclasses — TExpression, TTable, TFunctionCall, TObjectName, ...)
gudusoft.gsqlparser.stmt High-level statement wrappers (TSelectSqlStatement, TInsertSqlStatement, TUpdateSqlStatement, ...)
gudusoft.gsqlparser.stmt.mssql T-SQL-specific statements (TMssqlBlock, TMssqlCreateProcedure, TMssqlExecute, ...)
gudusoft.gsqlparser.stmt.oracle PL/SQL statements (TPlsqlCreatePackage, TSqlplusCmdStatement, ...)
gudusoft.gsqlparser.stmt.snowflake / teradata Vendor-specific statement classes
gudusoft.gsqlparser.pp Pretty-printer / SQL formatter
gudusoft.gsqlparser.scriptWriter AST -> SQL re-emission (TScriptGenerator, TScriptWriter)
gudusoft.gsqlparser.parser Per-vendor parser delegates (TOracleSqlParser, TMssqlSqlParser, ..., SqlParserFactory)
gudusoft.gsqlparser.sqlcmds Per-vendor command dispatch tables

Using the DocFX site

  • Start at the namespace index for a top-down overview.
  • Use the search box to jump straight to a class or member by name.
  • Member detail pages show the C# signature, summary, parameters, and inheritance chain.

In-source documentation

If you prefer to read documentation alongside the source, the comment style on the C# files in gsp_dotnet_core/src/gsqlparser/ matches the DocFX output exactly. TGSqlParser.cs and EDbVendor.cs are the best entry points.

See also