API documentation¶
This chapter briefly explains some implementation detail.
Packages
pglast.parser— The interface with libpg_querypglast.ast— Python classes representing PG parser nodesA_ArrayExprA_ConstA_ExprA_IndicesA_IndirectionA_StarAccessPrivAggrefAliasAlterCollationStmtAlterDatabaseRefreshCollStmtAlterDatabaseSetStmtAlterDatabaseStmtAlterDefaultPrivilegesStmtAlterDomainStmtAlterEnumStmtAlterEventTrigStmtAlterExtensionContentsStmtAlterExtensionStmtAlterFdwStmtAlterForeignServerStmtAlterFunctionStmtAlterObjectDependsStmtAlterObjectSchemaStmtAlterOpFamilyStmtAlterOperatorStmtAlterOwnerStmtAlterPolicyStmtAlterPublicationStmtAlterRoleSetStmtAlterRoleStmtAlterSeqStmtAlterStatsStmtAlterSubscriptionStmtAlterSystemStmtAlterTSConfigurationStmtAlterTSDictionaryStmtAlterTableCmdAlterTableMoveAllStmtAlterTableSpaceOptionsStmtAlterTableStmtAlterTypeStmtAlterUserMappingStmtAlternativeSubPlanArrayCoerceExprArrayExprBitStringBoolExprBooleanBooleanTestCTECycleClauseCTESearchClauseCallContextCallStmtCaseExprCaseTestExprCaseWhenCheckPointStmtClosePortalStmtClusterStmtCoalesceExprCoerceToDomainCoerceToDomainValueCoerceViaIOCollateClauseCollateExprColumnDefColumnRefCommentStmtCommonTableExprCompositeTypeStmtConstraintConstraintsSetStmtConvertRowtypeExprCopyStmtCreateAmStmtCreateCastStmtCreateConversionStmtCreateDomainStmtCreateEnumStmtCreateEventTrigStmtCreateExtensionStmtCreateFdwStmtCreateForeignServerStmtCreateForeignTableStmtCreateFunctionStmtCreateOpClassItemCreateOpClassStmtCreateOpFamilyStmtCreatePLangStmtCreatePolicyStmtCreatePublicationStmtCreateRangeStmtCreateRoleStmtCreateSchemaStmtCreateSeqStmtCreateStatsStmtCreateStmtCreateSubscriptionStmtCreateTableAsStmtCreateTableSpaceStmtCreateTransformStmtCreateTrigStmtCreateUserMappingStmtCreatedbStmtCurrentOfExprDeallocateStmtDeclareCursorStmtDefElemDefineStmtDeleteStmtDiscardStmtDoStmtDropOwnedStmtDropRoleStmtDropStmtDropSubscriptionStmtDropTableSpaceStmtDropUserMappingStmtDropdbStmtExecuteStmtExplainStmtFetchStmtFieldSelectFieldStoreFloatFromExprFuncCallFuncExprFunctionParameterGrantRoleStmtGrantStmtGroupingFuncGroupingSetImportForeignSchemaStmtIndexElemIndexStmtInferClauseInferenceElemInlineCodeBlockInsertStmtIntegerIntoClauseJoinExprJsonAggConstructorJsonArrayAggJsonArrayConstructorJsonArrayQueryConstructorJsonConstructorExprJsonFormatJsonIsPredicateJsonKeyValueJsonObjectAggJsonObjectConstructorJsonOutputJsonReturningJsonValueExprListenStmtLoadStmtLockStmtLockingClauseMergeActionMergeStmtMergeWhenClauseMinMaxExprMultiAssignRefNamedArgExprNotifyStmtNullTestObjectWithArgsOnConflictClauseOnConflictExprOpExprPLAssignStmtParamParamRefPartitionBoundSpecPartitionCmdPartitionElemPartitionRangeDatumPartitionSpecPrepareStmtPublicationObjSpecPublicationTableQueryRTEPermissionInfoRangeFunctionRangeSubselectRangeTableFuncRangeTableFuncColRangeTableSampleRangeTblEntryRangeTblFunctionRangeTblRefRangeVarRawStmtReassignOwnedStmtRefreshMatViewStmtReindexStmtRelabelTypeRenameStmtReplicaIdentityStmtResTargetReturnStmtRoleSpecRowCompareExprRowExprRowMarkClauseRuleStmtSQLValueFunctionScalarArrayOpExprSecLabelStmtSelectStmtSetOperationStmtSetToDefaultSortBySortGroupClauseStatsElemStringSubLinkSubPlanSubscriptingRefTableFuncTableLikeClauseTableSampleClauseTargetEntryTransactionStmtTriggerTransitionTruncateStmtTypeCastTypeNameUnlistenStmtUpdateStmtVacuumRelationVacuumStmtVarVariableSetStmtVariableShowStmtViewStmtWindowClauseWindowDefWindowFuncWithCheckOptionWithClauseXmlExprXmlSerialize
pglast.enums— Enumerated constantspglast.keywords— Various kinds of PostgreSQL keywordspglast.stream— The serialization machinerypglast.printers— Specialized printer functionspglast.printers.sfuncs— Special function printerspglast.visitors— Other ways to inspect and manipulate the AST