xref: /aosp_15_r20/external/googleapis/google/cloud/bigquery/storage/v1/avro.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.bigquery.storage.v1;
18
19option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
20option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
21option java_multiple_files = true;
22option java_outer_classname = "AvroProto";
23option java_package = "com.google.cloud.bigquery.storage.v1";
24option php_namespace = "Google\\Cloud\\BigQuery\\Storage\\V1";
25
26// Avro schema.
27message AvroSchema {
28  // Json serialized schema, as described at
29  // https://avro.apache.org/docs/1.8.1/spec.html.
30  string schema = 1;
31}
32
33// Avro rows.
34message AvroRows {
35  // Binary serialized rows in a block.
36  bytes serialized_binary_rows = 1;
37
38  // [Deprecated] The count of rows in the returning block.
39  // Please use the format-independent ReadRowsResponse.row_count instead.
40  int64 row_count = 2 [deprecated = true];
41}
42
43// Contains options specific to Avro Serialization.
44message AvroSerializationOptions {
45  // Enable displayName attribute in Avro schema.
46  //
47  // The Avro specification requires field names to be alphanumeric.  By
48  // default, in cases when column names do not conform to these requirements
49  // (e.g. non-ascii unicode codepoints) and Avro is requested as an output
50  // format, the CreateReadSession call will fail.
51  //
52  // Setting this field to true, populates avro field names with a placeholder
53  // value and populates a "displayName" attribute for every avro field with the
54  // original column name.
55  bool enable_display_name_attribute = 1;
56}
57