google-cloud-bigquery 0.23.0 → 0.24.0

data/lib/google/cloud/bigquery/dataset.rb

@@ -302,9 +302,6 @@ module Google
         #   length is 1,024 characters.
         # @param [String] name A descriptive name for the table.
         # @param [String] description A user-friendly description of the table.
-        # @param [Array<Schema::Field>] fields An array of Schema::Field objects
-        #   specifying the schema's data types for the table. The schema may
-        #   also be configured when passing a block.
         # @yield [table] a block for setting the table
         # @yieldparam [Table] table the table object to be updated
         #
@@ -326,26 +323,6 @@ module Google
         #                                name: "My Table",
         #                                description: "A description of table."
         #
-        # @example The table's schema fields can be passed as an argument.
-        #   require "google/cloud/bigquery"
-        #
-        #   bigquery = Google::Cloud::Bigquery.new
-        #   dataset = bigquery.dataset "my_dataset"
-        #
-        #   schema_fields = [
-        #     Google::Cloud::Bigquery::Schema::Field.new(
-        #       "first_name", :string, mode: :required),
-        #     Google::Cloud::Bigquery::Schema::Field.new(
-        #       "cities_lived", :record, mode: :repeated,
-        #       fields: [
-        #         Google::Cloud::Bigquery::Schema::Field.new(
-        #           "place", :string, mode: :required),
-        #         Google::Cloud::Bigquery::Schema::Field.new(
-        #           "number_of_years", :integer, mode: :required),
-        #         ])
-        #   ]
-        #   table = dataset.create_table "my_table", fields: schema_fields
-        #
         # @example Or the table's schema can be configured with the block.
         #   require "google/cloud/bigquery"
         #
@@ -379,7 +356,7 @@ module Google
         #
         # @!group Table
         #
-        def create_table table_id, name: nil, description: nil, fields: nil
+        def create_table table_id, name: nil, description: nil
           ensure_service!
           new_tb = Google::Apis::BigqueryV2::Table.new(
             table_reference: Google::Apis::BigqueryV2::TableReference.new(
@@ -388,7 +365,6 @@ module Google
           updater = Table::Updater.new(new_tb).tap do |tb|
             tb.name = name unless name.nil?
             tb.description = description unless description.nil?
-            tb.schema.fields = fields unless fields.nil?
           end
 
           yield updater if block_given?
@@ -407,6 +383,14 @@ module Google
         #   is referenced.
         # @param [String] name A descriptive name for the table.
         # @param [String] description A user-friendly description of the table.
+        # @param [Boolean] standard_sql Specifies whether to use BigQuery's
+        #   [standard
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
+        #   dialect. Optional. The default value is true.
+        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
+        #   [legacy
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
+        #   dialect. Optional. The default value is false.
         #
         # @return [Google::Cloud::Bigquery::View]
         #
@@ -416,7 +400,7 @@ module Google
         #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   view = dataset.create_view "my_view",
-        #             "SELECT name, age FROM [proj:dataset.users]"
+        #             "SELECT name, age FROM proj.dataset.users"
         #
         # @example A name and description can be provided:
         #   require "google/cloud/bigquery"
@@ -424,12 +408,13 @@ module Google
         #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   view = dataset.create_view "my_view",
-        #             "SELECT name, age FROM [proj:dataset.users]",
+        #             "SELECT name, age FROM proj.dataset.users",
         #             name: "My View", description: "This is my view"
         #
         # @!group Table
         #
-        def create_view table_id, query, name: nil, description: nil
+        def create_view table_id, query, name: nil, description: nil,
+                        standard_sql: nil, legacy_sql: nil
           new_view_opts = {
             table_reference: Google::Apis::BigqueryV2::TableReference.new(
               project_id: project_id, dataset_id: dataset_id, table_id: table_id
@@ -437,7 +422,9 @@ module Google
             friendly_name: name,
             description: description,
             view: Google::Apis::BigqueryV2::ViewDefinition.new(
-              query: query
+              query: query,
+              use_legacy_sql: Convert.resolve_legacy_sql(standard_sql,
+                                                         legacy_sql)
             )
           }.delete_if { |_, v| v.nil? }
           new_view = Google::Apis::BigqueryV2::Table.new new_view_opts
@@ -579,31 +566,28 @@ module Google
         #   * `append` - BigQuery appends the data to the table.
         #   * `empty` - A 'duplicate' error is returned in the job result if the
         #     table exists and contains data.
-        # @param [Boolean] large_results If `true`, allows the query to produce
-        #   arbitrarily large result tables at a slight cost in performance.
-        #   Requires `table` parameter to be set.
-        # @param [Boolean] flatten Flattens all nested and repeated fields in
-        #   the query results. The default value is `true`. `large_results`
-        #   parameter must be `true` if this is set to `false`.
-        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
-        #   [legacy
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
-        #   dialect for this query. If set to false, the query will use
-        #   BigQuery's [standard
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
-        #   When set to false, the values of `large_results` and `flatten` are
-        #   ignored; the query will be run as if `large_results` is true and
-        #   `flatten` is false. Optional. The default value is true.
         # @param [Boolean] standard_sql Specifies whether to use BigQuery's
         #   [standard
         #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
         #   dialect for this query. If set to true, the query will use standard
         #   SQL rather than the [legacy
         #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
-        #   dialect. When set to true, the values of `large_results` and
-        #   `flatten` are ignored; the query will be run as if `large_results`
-        #   is true and `flatten` is false. Optional. The default value is
-        #   false.
+        #   dialect. Optional. The default value is true.
+        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
+        #   [legacy
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
+        #   dialect for this query. If set to false, the query will use
+        #   BigQuery's [standard
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
+        #   dialect. Optional. The default value is false.
+        # @param [Boolean] large_results This option is specific to Legacy SQL.
+        #   If `true`, allows the query to produce arbitrarily large result
+        #   tables at a slight cost in performance. Requires `table` parameter
+        #   to be set.
+        # @param [Boolean] flatten This option is specific to Legacy SQL.
+        #   Flattens all nested and repeated fields in the query results. The
+        #   default value is `true`. `large_results` parameter must be `true` if
+        #   this is set to `false`.
         #
         # @return [Google::Cloud::Bigquery::QueryJob]
         #
@@ -621,13 +605,13 @@ module Google
         #     end
         #   end
         #
-        # @example Query using standard SQL:
+        # @example Query using legacy SQL:
         #   require "google/cloud/bigquery"
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
         #   job = bigquery.query_job "SELECT name FROM my_table",
-        #                            standard_sql: true
+        #                            legacy_sql: true
         #
         #   job.wait_until_done!
         #   if !job.failed?
@@ -669,8 +653,8 @@ module Google
         # @!group Data
         #
         def query_job query, params: nil, priority: "INTERACTIVE", cache: true,
-                      table: nil, create: nil, write: nil, large_results: nil,
-                      flatten: nil, legacy_sql: nil, standard_sql: nil
+                      table: nil, create: nil, write: nil, standard_sql: nil,
+                      legacy_sql: nil, large_results: nil, flatten: nil
           options = { priority: priority, cache: cache, table: table,
                       create: create, write: write,
                       large_results: large_results, flatten: flatten,
@@ -741,15 +725,6 @@ module Google
         #   whenever tables in the query are modified. The default value is
         #   true. For more information, see [query
         #   caching](https://developers.google.com/bigquery/querying-data).
-        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
-        #   [legacy
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
-        #   dialect for this query. If set to false, the query will use
-        #   BigQuery's [standard
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
-        #   When set to false, the values of `large_results` and `flatten` are
-        #   ignored; the query will be run as if `large_results` is true and
-        #   `flatten` is false. Optional. The default value is true.
         # @param [Boolean] standard_sql Specifies whether to use BigQuery's
         #   [standard
         #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
@@ -759,7 +734,16 @@ module Google
         #   dialect. When set to true, the values of `large_results` and
         #   `flatten` are ignored; the query will be run as if `large_results`
         #   is true and `flatten` is false. Optional. The default value is
-        #   false.
+        #   true.
+        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
+        #   [legacy
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
+        #   dialect for this query. If set to false, the query will use
+        #   BigQuery's [standard
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
+        #   When set to false, the values of `large_results` and `flatten` are
+        #   ignored; the query will be run as if `large_results` is true and
+        #   `flatten` is false. Optional. The default value is false.
         #
         # @return [Google::Cloud::Bigquery::QueryData]
         #
@@ -774,13 +758,13 @@ module Google
         #     puts row["name"]
         #   end
         #
-        # @example Query using standard SQL:
+        # @example Query using legacy SQL:
         #   require "google/cloud/bigquery"
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
         #   data = bigquery.query "SELECT name FROM my_table",
-        #                         standard_sql: true
+        #                         legacy_sql: true
         #
         #   data.each do |row|
         #     puts row["name"]
@@ -813,7 +797,7 @@ module Google
         # @!group Data
         #
         def query query, params: nil, max: nil, timeout: 10000, dryrun: nil,
-                  cache: true, legacy_sql: nil, standard_sql: nil
+                  cache: true, standard_sql: nil, legacy_sql: nil
           options = { max: max, timeout: timeout, dryrun: dryrun, cache: cache,
                       legacy_sql: legacy_sql, standard_sql: standard_sql,
                       params: params }

data/lib/google/cloud/bigquery/project.rb

@@ -158,30 +158,28 @@ module Google
         # @param [Boolean] large_results If `true`, allows the query to produce
         #   arbitrarily large result tables at a slight cost in performance.
         #   Requires `table` parameter to be set.
-        # @param [Boolean] flatten Flattens all nested and repeated fields in
-        #   the query results. The default value is `true`. `large_results`
-        #   parameter must be `true` if this is set to `false`.
-        # @param [Dataset, String] dataset Specifies the default dataset to use
-        #   for unqualified table names in the query.
-        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
-        #   [legacy
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
-        #   dialect for this query. If set to false, the query will use
-        #   BigQuery's [standard
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
-        #   When set to false, the values of `large_results` and `flatten` are
-        #   ignored; the query will be run as if `large_results` is true and
-        #   `flatten` is false. Optional. The default value is true.
         # @param [Boolean] standard_sql Specifies whether to use BigQuery's
         #   [standard
         #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
         #   dialect for this query. If set to true, the query will use standard
         #   SQL rather than the [legacy
         #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
-        #   dialect. When set to true, the values of `large_results` and
-        #   `flatten` are ignored; the query will be run as if `large_results`
-        #   is true and `flatten` is false. Optional. The default value is
-        #   false.
+        #   dialect. Optional. The default value is true.
+        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
+        #   [legacy
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
+        #   dialect for this query. If set to false, the query will use
+        #   BigQuery's [standard
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
+        #   dialect. Optional. The default value is false.
+        # @param [Boolean] large_results This option is specific to Legacy SQL.
+        #   If `true`, allows the query to produce arbitrarily large result
+        #   tables at a slight cost in performance. Requires `table` parameter
+        #   to be set.
+        # @param [Boolean] flatten This option is specific to Legacy SQL.
+        #   Flattens all nested and repeated fields in the query results. The
+        #   default value is `true`. `large_results` parameter must be `true` if
+        #   this is set to `false`.
         #
         # @return [Google::Cloud::Bigquery::QueryJob]
         #
@@ -200,14 +198,14 @@ module Google
         #     end
         #   end
         #
-        # @example Query using standard SQL:
+        # @example Query using legacy SQL:
         #   require "google/cloud/bigquery"
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
         #   job = bigquery.query_job "SELECT name FROM " \
         #                            "`my_proj.my_data.my_table`",
-        #                            standard_sql: true
+        #                            legacy_sql: true
         #
         #   job.wait_until_done!
         #   if !job.failed?
@@ -251,9 +249,9 @@ module Google
         #   end
         #
         def query_job query, params: nil, priority: "INTERACTIVE", cache: true,
-                      table: nil, create: nil, write: nil, large_results: nil,
-                      flatten: nil, dataset: nil, legacy_sql: nil,
-                      standard_sql: nil
+                      table: nil, create: nil, write: nil, dataset: nil,
+                      standard_sql: nil, legacy_sql: nil, large_results: nil,
+                      flatten: nil
           ensure_service!
           options = { priority: priority, cache: cache, table: table,
                       create: create, write: write,
@@ -327,15 +325,6 @@ module Google
         # @param [String] project Specifies the default projectId to assume for
         #   any unqualified table names in the query. Only used if `dataset`
         #   option is set.
-        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
-        #   [legacy
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
-        #   dialect for this query. If set to false, the query will use
-        #   BigQuery's [standard
-        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
-        #   When set to false, the values of `large_results` and `flatten` are
-        #   ignored; the query will be run as if `large_results` is true and
-        #   `flatten` is false. Optional. The default value is true.
         # @param [Boolean] standard_sql Specifies whether to use BigQuery's
         #   [standard
         #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
@@ -345,7 +334,16 @@ module Google
         #   dialect. When set to true, the values of `large_results` and
         #   `flatten` are ignored; the query will be run as if `large_results`
         #   is true and `flatten` is false. Optional. The default value is
-        #   false.
+        #   true.
+        # @param [Boolean] legacy_sql Specifies whether to use BigQuery's
+        #   [legacy
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql)
+        #   dialect for this query. If set to false, the query will use
+        #   BigQuery's [standard
+        #   SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
+        #   When set to false, the values of `large_results` and `flatten` are
+        #   ignored; the query will be run as if `large_results` is true and
+        #   `flatten` is false. Optional. The default value is false.
         #
         # @return [Google::Cloud::Bigquery::QueryData]
         #
@@ -354,19 +352,19 @@ module Google
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
-        #   data = bigquery.query "SELECT name FROM [my_proj:my_data.my_table]"
+        #   data = bigquery.query "SELECT name FROM `my_proj.my_data.my_table`"
         #
         #   data.each do |row|
         #     puts row["name"]
         #   end
         #
-        # @example Query using standard SQL:
+        # @example Query using legacy SQL:
         #   require "google/cloud/bigquery"
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
-        #   data = bigquery.query "SELECT name FROM `my_proj.my_data.my_table`",
-        #                         standard_sql: true
+        #   data = bigquery.query "SELECT name FROM [my_proj:my_data.my_table]",
+        #                         legacy_sql: true
         #
         #   data.each do |row|
         #     puts row["name"]
@@ -377,7 +375,7 @@ module Google
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
-        #   data = bigquery.query "SELECT name FROM [my_proj:my_data.my_table]"
+        #   data = bigquery.query "SELECT name FROM `my_proj.my_data.my_table`"
         #
         #   data.all do |row|
         #     puts row["name"]
@@ -389,7 +387,7 @@ module Google
         #   bigquery = Google::Cloud::Bigquery.new
         #
         #   data = bigquery.query "SELECT name " \
-        #                         "FROM [my_proj:my_data.my_table]" \
+        #                         "FROM `my_proj.my_data.my_table`" \
         #                         "WHERE id = ?",
         #                         params: [1]
         #
@@ -403,7 +401,7 @@ module Google
         #   bigquery = Google::Cloud::Bigquery.new
         #
         #   data = bigquery.query "SELECT name " \
-        #                         "FROM [my_proj:my_data.my_table]" \
+        #                         "FROM `my_proj.my_data.my_table`" \
         #                         "WHERE id = @id",
         #                         params: { id: 1 }
         #
@@ -412,8 +410,8 @@ module Google
         #   end
         #
         def query query, params: nil, max: nil, timeout: 10000, dryrun: nil,
-                  cache: true, dataset: nil, project: nil, legacy_sql: nil,
-                  standard_sql: nil
+                  cache: true, dataset: nil, project: nil, standard_sql: nil,
+                  legacy_sql: nil
           ensure_service!
           options = { max: max, timeout: timeout, dryrun: dryrun, cache: cache,
                       dataset: dataset, project: project,
@@ -710,7 +708,7 @@ module Google
         #
         #   fourpm = bigquery.time 16, 0, 0
         #   data = bigquery.query "SELECT name " \
-        #                         "FROM [my_proj:my_data.my_table]" \
+        #                         "FROM `my_proj.my_data.my_table`" \
         #                         "WHERE time_of_date = @time",
         #                         params: { time: fourpm }
         #
@@ -725,7 +723,7 @@ module Google
         #
         #   precise_time = bigquery.time 16, 35, 15.376541
         #   data = bigquery.query "SELECT name " \
-        #                         "FROM [my_proj:my_data.my_table]" \
+        #                         "FROM `my_proj.my_data.my_table`" \
         #                         "WHERE time_of_date >= @time",
         #                         params: { time: precise_time }
         #

data/lib/google/cloud/bigquery/query_data.rb

@@ -55,22 +55,24 @@ module Google
         ##
         # The schema of the data.
         def schema
-          Schema.from_gapi(@gapi.schema).freeze
+          @schema ||= begin
+            s = Schema.from_gapi(@gapi.schema)
+            # call fields so they will be available
+            s.fields
+            s.freeze
+          end
         end
 
         ##
         # The fields of the data.
         def fields
-          f = schema.fields
-          f = f.to_hash if f.respond_to? :to_hash
-          f = [] if f.nil?
-          f
+          schema.fields
         end
 
         ##
         # The name of the columns in the data.
         def headers
-          fields.map(&:name)
+          schema.headers
         end
 
         ##
@@ -202,8 +204,7 @@ module Google
           if gapi.schema.nil?
             formatted_rows = []
           else
-            formatted_rows = format_rows gapi.rows,
-                                         gapi.schema.fields
+            formatted_rows = Convert.format_rows gapi.rows, gapi.schema.fields
           end
 
           data = new formatted_rows