Skip to content
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

Remove TableInfo hierarchy, add TableType hierarchy #600

Merged
merged 5 commits into from
Feb 2, 2016
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,23 +125,25 @@ Here is a code snippet showing a simple usage example from within Compute/App En
must [supply credentials](#authentication) and a project ID if running this snippet elsewhere.

```java
import com.google.gcloud.bigquery.BaseTableInfo;
import com.google.gcloud.bigquery.BigQuery;
import com.google.gcloud.bigquery.BigQueryOptions;
import com.google.gcloud.bigquery.TableDefinition;
import com.google.gcloud.bigquery.Field;
import com.google.gcloud.bigquery.JobStatus;
import com.google.gcloud.bigquery.JobInfo;
import com.google.gcloud.bigquery.LoadJobConfiguration;
import com.google.gcloud.bigquery.Schema;
import com.google.gcloud.bigquery.TableId;
import com.google.gcloud.bigquery.TableInfo;

BigQuery bigquery = BigQueryOptions.defaultInstance().service();
TableId tableId = TableId.of("dataset", "table");
BaseTableInfo info = bigquery.getTable(tableId);
TableInfo info = bigquery.getTable(tableId);
if (info == null) {
System.out.println("Creating table " + tableId);
Field integerField = Field.of("fieldName", Field.Type.integer());
bigquery.create(TableInfo.of(tableId, Schema.of(integerField)));
Schema schema = Schema.of(integerField);

This comment was marked as spam.

bigquery.create(TableInfo.of(tableId, TableDefinition.of(schema)));
} else {
System.out.println("Loading data into table " + tableId);
LoadJobConfiguration configuration = LoadJobConfiguration.of(tableId, "gs://bucket/path");
Expand Down
12 changes: 7 additions & 5 deletions gcloud-java-bigquery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ are created from a BigQuery SQL query. In this code snippet we show how to creat
with only one string field. Add the following imports at the top of your file:

```java
import com.google.gcloud.bigquery.BaseTableInfo;
import com.google.gcloud.bigquery.TableDefinition;
import com.google.gcloud.bigquery.Field;
import com.google.gcloud.bigquery.Schema;
import com.google.gcloud.bigquery.TableId;
Expand All @@ -126,7 +126,8 @@ Field stringField = Field.of("StringField", Field.Type.string());
// Table schema definition
Schema schema = Schema.of(stringField);
// Create a table
TableInfo createdTableInfo = bigquery.create(TableInfo.of(tableId, schema));
TableDefinition tableDefinition = TableDefinition.of(schema);
TableInfo createdTableInfo = bigquery.create(TableInfo.of(tableId, tableDefinition));
```

#### Loading data into a table
Expand Down Expand Up @@ -204,10 +205,10 @@ the code from the main method to your application's servlet class and change the
display on your webpage.

```java
import com.google.gcloud.bigquery.BaseTableInfo;
import com.google.gcloud.bigquery.BigQuery;
import com.google.gcloud.bigquery.BigQueryOptions;
import com.google.gcloud.bigquery.DatasetInfo;
import com.google.gcloud.bigquery.TableDefinition;
import com.google.gcloud.bigquery.Field;
import com.google.gcloud.bigquery.FieldValue;
import com.google.gcloud.bigquery.InsertAllRequest;
Expand Down Expand Up @@ -240,7 +241,8 @@ public class GcloudBigQueryExample {
// Table schema definition
Schema schema = Schema.of(stringField);
// Create a table
TableInfo createdTableInfo = bigquery.create(TableInfo.of(tableId, schema));
TableDefinition tableDefinition = TableDefinition.of(schema);
TableInfo createdTableInfo = bigquery.create(TableInfo.of(tableId, tableDefinition));

// Define rows to insert
Map<String, Object> firstRow = new HashMap<>();
Expand All @@ -267,7 +269,7 @@ public class GcloudBigQueryExample {
.build();
// Request query to be executed and wait for results
QueryResponse queryResponse = bigquery.query(queryRequest);
while (!queryResponse.jobComplete()) {
while (!queryResponse.jobCompleted()) {
Thread.sleep(1000L);
queryResponse = bigquery.getQueryResults(queryResponse.jobId());
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
/*
* Copyright 2016 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.google.gcloud.bigquery;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.api.services.bigquery.model.Table;
import com.google.common.base.MoreObjects;

import java.io.Serializable;
import java.util.Objects;

/**
* Base class for a Google BigQuery table type.
*/
public abstract class BaseTableDefinition implements Serializable {

private static final long serialVersionUID = -374760330662959529L;

/**
* The table type.
*/
public enum Type {
/**
* A normal BigQuery table. Instances of {@code BaseTableDefinition} for this type are
* implemented by {@link TableDefinition}.
*/
TABLE,

/**
* A virtual table defined by a SQL query. Instances of {@code BaseTableDefinition} for this
* type are implemented by {@link ViewDefinition}.
*
* @see <a href="https://cloud.google.com/bigquery/querying-data#views">Views</a>
*/
VIEW,

/**
* A BigQuery table backed by external data. Instances of {@code BaseTableDefinition} for this
* type are implemented by {@link ExternalTableDefinition}.
*
* @see <a href="https://cloud.google.com/bigquery/federated-data-sources">Federated Data
* Sources</a>
*/
EXTERNAL
}

private final Type type;

This comment was marked as spam.

private final Schema schema;

/**
* Base builder for table types.
*
* @param <T> the table type class
* @param <B> the table type builder
*/
public abstract static class Builder<T extends BaseTableDefinition, B extends Builder<T, B>> {

private Type type;
private Schema schema;

Builder(Type type) {
this.type = type;
}

Builder(BaseTableDefinition tableDefinition) {
this.type = tableDefinition.type;
this.schema = tableDefinition.schema;
}

Builder(Table tablePb) {
this.type = Type.valueOf(tablePb.getType());
if (tablePb.getSchema() != null) {
this.schema(Schema.fromPb(tablePb.getSchema()));
}
}

@SuppressWarnings("unchecked")
B self() {
return (B) this;
}

B type(Type type) {
this.type = type;
return self();
}

/**
* Sets the table schema.
*/
public B schema(Schema schema) {
this.schema = checkNotNull(schema);
return self();
}

/**
* Creates an object.
*/
public abstract T build();
}

BaseTableDefinition(Builder builder) {
this.type = builder.type;
this.schema = builder.schema;
}

/**
* Returns the table's type. If this table is simple table the method returns {@link Type#TABLE}.
* If this table is an external table this method returns {@link Type#EXTERNAL}. If this table is
* a view table this method returns {@link Type#VIEW}.
*/
public Type type() {
return type;
}

/**
* Returns the table's schema.
*/
public Schema schema() {
return schema;
}

/**
* Returns a builder for the object.
*/
public abstract Builder toBuilder();

MoreObjects.ToStringHelper toStringHelper() {
return MoreObjects.toStringHelper(this).add("type", type).add("schema", schema);
}

@Override
public String toString() {
return toStringHelper().toString();
}

final int baseHashCode() {
return Objects.hash(type);
}

final boolean baseEquals(BaseTableDefinition jobConfiguration) {
return Objects.equals(toPb(), jobConfiguration.toPb());
}

Table toPb() {
Table tablePb = new Table();
if (schema != null) {
tablePb.setSchema(schema.toPb());
}
tablePb.setType(type.name());
return tablePb;
}

@SuppressWarnings("unchecked")
static <T extends BaseTableDefinition> T fromPb(Table tablePb) {
switch (Type.valueOf(tablePb.getType())) {
case TABLE:
return (T) TableDefinition.fromPb(tablePb);
case VIEW:
return (T) ViewDefinition.fromPb(tablePb);
case EXTERNAL:
return (T) ExternalTableDefinition.fromPb(tablePb);
default:
// never reached
throw new IllegalArgumentException("Format " + tablePb.getType() + " is not supported");
}
}
}
Loading