io.cdap.plugin.gcp.bigquery.sink.lib.BigQueryTableHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud Show documentation
Plugins for Google Big Query
The newest version!
/*
 * Copyright © 2023 Cask Data, Inc.
 *
 * 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 io.cdap.plugin.gcp.bigquery.sink.lib;

import com.google.api.client.json.JsonParser;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.bigquery.model.TableFieldSchema;
import com.google.api.services.bigquery.model.TableSchema;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/** Helper for BigQuery tables.
 * - Moved from com.google.cloud.hadoop.io.bigquery bigquery-connector library
 * - Update the table regex as per the requirement of flexible column names
 * TODO(PLUGIN-1725): Migrate to Spark BigQuery connector.
 */
class BigQueryTableHelper {
  /**
   * Parses table schema JSON into {@link TableSchema}.
   *
   * @param tableSchemaJson JSON table schema to convert to {@link TableSchema}
   * @return {@link TableSchema}
   * @throws IOException if the JSON is invalid.
   */
  static TableSchema parseTableSchema(String tableSchemaJson) throws IOException {
    JsonParser parser = JacksonFactory.getDefaultInstance().createJsonParser(tableSchemaJson);
    return parser.parseAndClose(TableSchema.class);
  }

  /**
   * Creates {@link TableSchema} from the JSON representation of the table fields.
   *
   * @param fieldsJson JSON fields to convert to {@link TableSchema}
   * @return {@link TableSchema}
   * @throws IOException
   */
  static TableSchema createTableSchemaFromFields(String fieldsJson) throws IOException {
    List fields = new ArrayList<>();
    JsonParser parser = JacksonFactory.getDefaultInstance().createJsonParser(fieldsJson);
    parser.parseArrayAndClose(fields, TableFieldSchema.class);

    return new TableSchema().setFields(fields);
  }

  /**
   * Gets the JSON representation of the table schema.
   *
   * @param tableSchema {@link TableSchema} to convert to JSON
   * @return the JSON of the table schema.
   * @throws IOException
   */
  static String getTableSchemaJson(TableSchema tableSchema) throws IOException {
    return JacksonFactory.getDefaultInstance().toString(tableSchema);
  }

  /**
   * Gets the JSON representation of the table's fields.
   *
   * @param tableSchema {@link TableSchema} to get JSON fields from
   * @return the JSON of the fields.
   * @throws IOException
   */
  static String getTableFieldsJson(TableSchema tableSchema) throws IOException {
    return JacksonFactory.getDefaultInstance().toString(tableSchema.getFields());
  }
}