generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 76
Added support for OPENXML with WITH clause #587
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.
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
Deepesh125
merged 9 commits into
babelfish-for-postgresql:BABEL_5_X_DEV__PG_17_X
from
harshdubey166:BABEL_3635
Sep 24, 2025
Merged
Added support for OPENXML with WITH clause #587
Deepesh125
merged 9 commits into
babelfish-for-postgresql:BABEL_5_X_DEV__PG_17_X
from
harshdubey166:BABEL_3635
Sep 24, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Harsh Dubey <[email protected]>
KushaalShroff
requested changes
Jun 19, 2025
Signed-off-by: Harsh Dubey <[email protected]>
1 task
Signed-off-by: Harsh Dubey <[email protected]>
rohit01010
reviewed
Jun 20, 2025
Deepesh125
requested changes
Jun 21, 2025
Signed-off-by: Harsh Dubey <[email protected]>
This was referenced Jun 27, 2025
rohit01010
approved these changes
Sep 16, 2025
Signed-off-by: Harsh Dubey <[email protected]>
Signed-off-by: Harsh Dubey <[email protected]>
rohit01010
approved these changes
Sep 17, 2025
rohit01010
approved these changes
Sep 23, 2025
Deepesh125
approved these changes
Sep 23, 2025
Deepesh125
reviewed
Sep 23, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update description
KushaalShroff
approved these changes
Sep 24, 2025
Deepesh125
approved these changes
Sep 24, 2025
8d438f9
into
babelfish-for-postgresql:BABEL_5_X_DEV__PG_17_X
2 checks passed
Deepesh125
pushed a commit
to babelfish-for-postgresql/babelfish_extensions
that referenced
this pull request
Sep 24, 2025
OPENXML provides a rowset view over an XML document. Since OPENXML is a rowset provider and it returns a set of
rows, we can use OPENXML in the FROM clause of a TSQL query just as we can use any other table, view, or table-
valued function. The WITH clause in OPENXML provides a rowset format (and additional mapping information as
required) by using either SchemaDeclaration or specifying an existing TableName.
Primary objective of this commit is to add support for OPENXML with WITH clause.
The syntax of openxml is as follows :
OPENXML ( idoc int [ in ] , rowpattern nvarchar [ in ], [ flags byte [ in ] ] )
[ WITH ( SchemaDeclaration | TableName ) ]
Arguments:
idoc - The document handle of the internal representation of an XML document. The internal representation of an XML
document is created by calling sp_xml_preparedocument.
rowpattern - The XPath pattern used to identify the nodes to be processed as rows. The nodes come from the XML
document whose handle is passed in the idoc parameter.
flags - Indicates the mapping used between the XML data and the relational rowset, and how the spill-over column is
filled. flags is an optional input parameter.
The WITH clause provides a rowset format (and additional mapping information as required) by using either
SchemaDeclaration or specifying an existing TableName. If the optional WITH clause isn't specified, the results are
returned in an edge table format. Edge tables represent the fine-grained XML document structure (such as
element/attribute names, the document hierarchy, the namespaces, PIs, and so on) as a single table.
Engine PR : babelfish-for-postgresql/postgresql_modified_for_babelfish#587
Task: BABEL-3635, BABEL-6045
Signed-off-by: Harsh Dubey <[email protected]>
Vineetha125
pushed a commit
to amazon-aurora/babelfish_extensions
that referenced
this pull request
Sep 25, 2025
OPENXML provides a rowset view over an XML document. Since OPENXML is a rowset provider and it returns a set of
rows, we can use OPENXML in the FROM clause of a TSQL query just as we can use any other table, view, or table-
valued function. The WITH clause in OPENXML provides a rowset format (and additional mapping information as
required) by using either SchemaDeclaration or specifying an existing TableName.
Primary objective of this commit is to add support for OPENXML with WITH clause.
The syntax of openxml is as follows :
OPENXML ( idoc int [ in ] , rowpattern nvarchar [ in ], [ flags byte [ in ] ] )
[ WITH ( SchemaDeclaration | TableName ) ]
Arguments:
idoc - The document handle of the internal representation of an XML document. The internal representation of an XML
document is created by calling sp_xml_preparedocument.
rowpattern - The XPath pattern used to identify the nodes to be processed as rows. The nodes come from the XML
document whose handle is passed in the idoc parameter.
flags - Indicates the mapping used between the XML data and the relational rowset, and how the spill-over column is
filled. flags is an optional input parameter.
The WITH clause provides a rowset format (and additional mapping information as required) by using either
SchemaDeclaration or specifying an existing TableName. If the optional WITH clause isn't specified, the results are
returned in an edge table format. Edge tables represent the fine-grained XML document structure (such as
element/attribute names, the document hierarchy, the namespaces, PIs, and so on) as a single table.
Engine PR : babelfish-for-postgresql/postgresql_modified_for_babelfish#587
Task: BABEL-3635, BABEL-6045
Signed-off-by: Harsh Dubey <[email protected]>
Yvinayak07
pushed a commit
to amazon-aurora/postgresql_modified_for_babelfish
that referenced
this pull request
Oct 16, 2025
…abelfish-for-postgresql#587) To add support for Openxml with WITH clause, this commit exposes wrapper hooks to facilitate support for T-SQL OPENXML functionalities by allowing Babelfish to customised XML table processing during query parsing. Added two new hooks: 1. pre_transform_openxml_columns_hook , to allow extensions to pre-process OPENXML column definitions before standard XMLTABLE transformation. 2. openxml_set_namespaces_hook, which fetches and register namespaces in xpath context. Extensions PR : babelfish-for-postgresql/babelfish_extensions#3820 Task: BABEL-3635, BABEL 6045 Signed-off-by: Harsh Dubey <[email protected]>
Yvinayak07
pushed a commit
to amazon-aurora/postgresql_modified_for_babelfish
that referenced
this pull request
Oct 16, 2025
…abelfish-for-postgresql#587) To add support for Openxml with WITH clause, this commit exposes wrapper hooks to facilitate support for T-SQL OPENXML functionalities by allowing Babelfish to customised XML table processing during query parsing. Added two new hooks: 1. pre_transform_openxml_columns_hook , to allow extensions to pre-process OPENXML column definitions before standard XMLTABLE transformation. 2. openxml_set_namespaces_hook, which fetches and register namespaces in xpath context. Extensions PR : babelfish-for-postgresql/babelfish_extensions#3820 Task: BABEL-3635, BABEL 6045 Signed-off-by: Harsh Dubey <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
To add support for Openxml with WITH clause, this PR exposes wrapper hooks to facilitate support for T-SQL OPENXML functionality by allowing babelfish to customize XML table processing during query parsing.
Added two new hooks:
pre_transform_openxml_columns_hook, to allow extensions to pre-process OPENXML column definitionsbefore standard XMLTABLE transformation.
openxml_set_namespaces_hook, which fetches and register namespaces in xpath context.Extensions PR : babelfish-for-postgresql/babelfish_extensions#3820
Signed-off-by: Harsh Dubey [email protected]
Authored by : Harsh Dubey [email protected]
Issues Resolved
BABEL-3635, BABEL 6045
Check List
By submitting this pull request, I confirm that my contribution is under the terms of the PostgreSQL license, and grant any person obtaining a copy of the contribution permission to relicense all or a portion of my contribution to the PostgreSQL License solely to contribute all or a portion of my contribution to the PostgreSQL open source project.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.