| // Copyright 2015 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 bigquery |
| |
| import ( |
| "fmt" |
| |
| "golang.org/x/net/context" |
| bq "google.golang.org/api/bigquery/v2" |
| ) |
| |
| type queryOption interface { |
| customizeQuery(conf *bq.JobConfigurationQuery) |
| } |
| |
| // DisableQueryCache returns an Option that prevents results being fetched from the query cache. |
| // If this Option is not used, results are fetched from the cache if they are available. |
| // The query cache is a best-effort cache that is flushed whenever tables in the query are modified. |
| // Cached results are only available when TableID is unspecified in the query's destination Table. |
| // For more information, see https://cloud.google.com/bigquery/querying-data#querycaching |
| func DisableQueryCache() Option { return disableQueryCache{} } |
| |
| type disableQueryCache struct{} |
| |
| func (opt disableQueryCache) implementsOption() {} |
| |
| func (opt disableQueryCache) customizeQuery(conf *bq.JobConfigurationQuery) { |
| f := false |
| conf.UseQueryCache = &f |
| } |
| |
| // DisableFlattenedResults returns an Option that prevents results being flattened. |
| // If this Option is not used, results from nested and repeated fields are flattened. |
| // DisableFlattenedResults implies AllowLargeResults |
| // For more information, see https://cloud.google.com/bigquery/docs/data#nested |
| func DisableFlattenedResults() Option { return disableFlattenedResults{} } |
| |
| type disableFlattenedResults struct{} |
| |
| func (opt disableFlattenedResults) implementsOption() {} |
| |
| func (opt disableFlattenedResults) customizeQuery(conf *bq.JobConfigurationQuery) { |
| f := false |
| conf.FlattenResults = &f |
| // DisableFlattenedResults implies AllowLargeResults |
| allowLargeResults{}.customizeQuery(conf) |
| } |
| |
| // AllowLargeResults returns an Option that allows the query to produce arbitrarily large result tables. |
| // The destination must be a table. |
| // When using this option, queries will take longer to execute, even if the result set is small. |
| // For additional limitations, see https://cloud.google.com/bigquery/querying-data#largequeryresults |
| func AllowLargeResults() Option { return allowLargeResults{} } |
| |
| type allowLargeResults struct{} |
| |
| func (opt allowLargeResults) implementsOption() {} |
| |
| func (opt allowLargeResults) customizeQuery(conf *bq.JobConfigurationQuery) { |
| conf.AllowLargeResults = true |
| } |
| |
| // JobPriority returns an Option that causes a query to be scheduled with the specified priority. |
| // The default priority is InteractivePriority. |
| // For more information, see https://cloud.google.com/bigquery/querying-data#batchqueries |
| func JobPriority(priority string) Option { return jobPriority(priority) } |
| |
| type jobPriority string |
| |
| func (opt jobPriority) implementsOption() {} |
| |
| func (opt jobPriority) customizeQuery(conf *bq.JobConfigurationQuery) { |
| conf.Priority = string(opt) |
| } |
| |
| const ( |
| BatchPriority = "BATCH" |
| InteractivePriority = "INTERACTIVE" |
| ) |
| |
| // MaxBillingTier returns an Option that sets the maximum billing tier for a Query. |
| // Queries that have resource usage beyond this tier will fail (without |
| // incurring a charge). If this Option is not used, the project default will be used. |
| func MaxBillingTier(tier int) Option { return maxBillingTier(tier) } |
| |
| type maxBillingTier int |
| |
| func (opt maxBillingTier) implementsOption() {} |
| |
| func (opt maxBillingTier) customizeQuery(conf *bq.JobConfigurationQuery) { |
| tier := int64(opt) |
| conf.MaximumBillingTier = &tier |
| } |
| |
| // MaxBytesBilled returns an Option that limits the number of bytes billed for |
| // this job. Queries that would exceed this limit will fail (without incurring |
| // a charge). |
| // If this Option is not used, or bytes is < 1, the project default will be |
| // used. |
| func MaxBytesBilled(bytes int64) Option { return maxBytesBilled(bytes) } |
| |
| type maxBytesBilled int64 |
| |
| func (opt maxBytesBilled) implementsOption() {} |
| |
| func (opt maxBytesBilled) customizeQuery(conf *bq.JobConfigurationQuery) { |
| if opt >= 1 { |
| conf.MaximumBytesBilled = int64(opt) |
| } |
| } |
| |
| // QueryUseStandardSQL returns an Option that set the query to use standard SQL. |
| // The default setting is false (using legacy SQL). |
| func QueryUseStandardSQL() Option { return queryUseStandardSQL{} } |
| |
| type queryUseStandardSQL struct{} |
| |
| func (opt queryUseStandardSQL) implementsOption() {} |
| |
| func (opt queryUseStandardSQL) customizeQuery(conf *bq.JobConfigurationQuery) { |
| conf.UseLegacySql = false |
| conf.ForceSendFields = append(conf.ForceSendFields, "UseLegacySql") |
| } |
| |
| func (c *Client) query(ctx context.Context, dst *Table, src *Query, options []Option) (*Job, error) { |
| job, options := initJobProto(c.projectID, options) |
| payload := &bq.JobConfigurationQuery{} |
| |
| dst.customizeQueryDst(payload) |
| src.customizeQuerySrc(payload) |
| |
| for _, opt := range options { |
| o, ok := opt.(queryOption) |
| if !ok { |
| return nil, fmt.Errorf("option (%#v) not applicable to dst/src pair: dst: %T ; src: %T", opt, dst, src) |
| } |
| o.customizeQuery(payload) |
| } |
| |
| job.Configuration = &bq.JobConfiguration{ |
| Query: payload, |
| } |
| j, err := c.service.insertJob(ctx, job, c.projectID) |
| if err != nil { |
| return nil, err |
| } |
| j.isQuery = true |
| return j, nil |
| } |