You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by tg...@apache.org on 2017/03/15 22:44:34 UTC
[1/2] beam git commit: This closes #2254
Repository: beam
Updated Branches:
refs/heads/master 477e789a4 -> 004d3078f
This closes #2254
Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/004d3078
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/004d3078
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/004d3078
Branch: refs/heads/master
Commit: 004d3078f14c26452ac3c4c4ca13dde894ff42b1
Parents: 477e789 c0b5476
Author: Thomas Groh <tg...@google.com>
Authored: Wed Mar 15 15:44:11 2017 -0700
Committer: Thomas Groh <tg...@google.com>
Committed: Wed Mar 15 15:44:11 2017 -0700
----------------------------------------------------------------------
.../beam/sdk/io/gcp/bigquery/BigQueryIO.java | 47 ++++++++------------
1 file changed, 19 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
[2/2] beam git commit: A few comment fixups in BigQueryIO
Posted by tg...@apache.org.
A few comment fixups in BigQueryIO
Some of the comments were lost in a recent cleanup PR.
Some other comments, I just made them shorter and equally or more clear.
(the fact that builder methods don't modify the current object, I
believe, does not need to be spelled out on every builder method
of every transform)
Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/c0b5476c
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/c0b5476c
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/c0b5476c
Branch: refs/heads/master
Commit: c0b5476c688f73fe5eb77fe0bad62c04a903cfce
Parents: 477e789
Author: Eugene Kirpichov <ki...@google.com>
Authored: Wed Mar 15 15:01:12 2017 -0700
Committer: Thomas Groh <tg...@google.com>
Committed: Wed Mar 15 15:44:11 2017 -0700
----------------------------------------------------------------------
.../beam/sdk/io/gcp/bigquery/BigQueryIO.java | 47 ++++++++------------
1 file changed, 19 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/beam/blob/c0b5476c/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java
----------------------------------------------------------------------
diff --git a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java
index 3e699d2..2ae357e 100644
--- a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java
+++ b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java
@@ -513,6 +513,14 @@ public class BigQueryIO {
/**
* Reads results received after executing the given query.
+ *
+ * <p>By default, the query results will be flattened -- see
+ * "flattenResults" in the <a href="https://cloud.google.com/bigquery/docs/reference/v2/jobs">
+ * Jobs documentation</a> for more information. To disable flattening, use
+ * {@link BigQueryIO.Read#withoutResultFlattening}.
+ *
+ * <p>By default, the query will use BigQuery's legacy SQL dialect. To use the BigQuery
+ * Standard SQL dialect, use {@link BigQueryIO.Read#usingStandardSql}.
*/
public Read fromQuery(String query) {
return fromQuery(StaticValueProvider.of(query));
@@ -1500,20 +1508,18 @@ public class BigQueryIO {
}
/**
- * Creates a write transformation for the given table specification.
- *
- * <p>Refer to {@link #parseTableSpec(String)} for the specification format.
+ * Writes to the given table, specified in the format described in {@link #parseTableSpec}.
*/
public Write to(String tableSpec) {
return to(StaticValueProvider.of(tableSpec));
}
- /** Creates a write transformation for the given table. */
+ /** Writes to the given table, specified as a {@link TableReference}. */
public Write to(TableReference table) {
return to(StaticValueProvider.of(toTableSpec(table)));
}
- /** Creates a write transformation for the given table. */
+ /** Same as {@link #to(String)}, but with a {@link ValueProvider}. */
public Write to(ValueProvider<String> tableSpec) {
ensureToNotCalledYet();
return toBuilder()
@@ -1567,10 +1573,11 @@ public class BigQueryIO {
}
/**
- * Returns a copy of this write transformation, but using the specified schema for rows
- * to be written.
+ * Uses the specified schema for rows to be written.
*
- * <p>Does not modify this object.
+ * <p>The schema is <i>required</i> only if writing to a table that does not already
+ * exist, and {@link CreateDisposition} is set to
+ * {@link CreateDisposition#CREATE_IF_NEEDED}.
*/
public Write withSchema(TableSchema schema) {
return toBuilder()
@@ -1587,38 +1594,22 @@ public class BigQueryIO {
.build();
}
- /**
- * Returns a copy of this write transformation, but using the specified create disposition.
- *
- * <p>Does not modify this object.
- */
+ /** Specifies whether the table should be created if it does not exist. */
public Write withCreateDisposition(CreateDisposition createDisposition) {
return toBuilder().setCreateDisposition(createDisposition).build();
}
- /**
- * Returns a copy of this write transformation, but using the specified write disposition.
- *
- * <p>Does not modify this object.
- */
+ /** Specifies what to do with existing data in the table, in case the table already exists. */
public Write withWriteDisposition(WriteDisposition writeDisposition) {
return toBuilder().setWriteDisposition(writeDisposition).build();
}
- /**
- * Returns a copy of this write transformation, but using the specified table description.
- *
- * <p>Does not modify this object.
- */
+ /** Specifies the table description. */
public Write withTableDescription(String tableDescription) {
return toBuilder().setTableDescription(tableDescription).build();
}
- /**
- * Returns a copy of this write transformation, but without BigQuery table validation.
- *
- * <p>Does not modify this object.
- */
+ /** Disables BigQuery table validation. */
public Write withoutValidation() {
return toBuilder().setValidate(false).build();
}