Skip to content

Update SQL doc to reflect changes in the APIs#397

Closed
akedin wants to merge 1 commit intoapache:asf-sitefrom
akedin:sql-doc-api-update
Closed

Update SQL doc to reflect changes in the APIs#397
akedin wants to merge 1 commit intoapache:asf-sitefrom
akedin:sql-doc-api-update

Conversation

@akedin
Copy link

@akedin akedin commented Mar 2, 2018

BeamSql.querySimple() and queryMulti() were combined into query().
BeamRecord was renamed to Row. Factory methods and builders were added to it.

@akedin
Copy link
Author

akedin commented Mar 2, 2018

R: @kennknowles @apilloud

## 1. Overview {#overview}

SQL is a well-adopted standard to process data with concise syntax. With DSL APIs (currently available only in Java), now `PCollection`s can be queried with standard SQL statements, like a regular table. The DSL APIs leverage [Apache Calcite](http://calcite.apache.org/) to parse and optimize SQL queries, then translate into a composite Beam `PTransform`. In this way, both SQL and normal Beam `PTransform`s can be mixed in the same pipeline.
SQL is a well-adopted standard to process data with concise syntax. With DSL APIs (currently available only in Java), now `PCollections` can be queried with standard SQL statements, like a regular table. The DSL APIs leverage [Apache Calcite](http://calcite.apache.org/) to parse and optimize SQL queries, then translate into a composite Beam `PTransform`. In this way, both SQL and normal Beam `PTransforms` can be mixed in the same pipeline.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive by comment -- if you end up making another commit for this PR, could we axe the * TOC {:toc} lines at the top of the page? We didn't have the right nav at the time this was added. Due to the bolding of a couple of the deeply nested sections, it looks a bit strange also.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed

BeamSql.querySimple() and queryMulti() were combined into query().
BeamRecord was renamed to Row. Factory methods and builders were added to it.
@akedin akedin force-pushed the sql-doc-api-update branch from 300229b to 50734de Compare March 7, 2018 19:26
Copy link
Member

@kennknowles kennknowles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is hugely useful and important. I think we should merge it immediately and make any further refinements after.

@kennknowles
Copy link
Member

retest this please

@kennknowles
Copy link
Member

One next step would be to use snippets capabilities to make sure these keep compiling.

@melap
Copy link

melap commented Mar 8, 2018

May need to be merged manually, as mergebot is having troubles right now.

@melap
Copy link

melap commented Mar 9, 2018

@asfgit merge

asfgit pushed a commit that referenced this pull request Mar 9, 2018
@asfgit
Copy link

asfgit commented Mar 9, 2018

Error: Custom preparation command failed. Check logs for more information.

@melap
Copy link

melap commented Mar 21, 2018

@asfgit merge

@asfgit asfgit closed this in 5e2de4d Mar 21, 2018
robertwb pushed a commit to robertwb/incubator-beam that referenced this pull request Jun 5, 2018
charlesccychen pushed a commit to cosmoskitten/beam that referenced this pull request Jun 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants