avro.proto 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. // Copyright 2022 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. syntax = "proto3";
  15. package google.cloud.bigquery.storage.v1;
  16. option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
  17. option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
  18. option java_multiple_files = true;
  19. option java_outer_classname = "AvroProto";
  20. option java_package = "com.google.cloud.bigquery.storage.v1";
  21. option php_namespace = "Google\\Cloud\\BigQuery\\Storage\\V1";
  22. // Avro schema.
  23. message AvroSchema {
  24. // Json serialized schema, as described at
  25. // https://avro.apache.org/docs/1.8.1/spec.html.
  26. string schema = 1;
  27. }
  28. // Avro rows.
  29. message AvroRows {
  30. // Binary serialized rows in a block.
  31. bytes serialized_binary_rows = 1;
  32. // [Deprecated] The count of rows in the returning block.
  33. // Please use the format-independent ReadRowsResponse.row_count instead.
  34. int64 row_count = 2 [deprecated = true];
  35. }
  36. // Contains options specific to Avro Serialization.
  37. message AvroSerializationOptions {
  38. // Enable displayName attribute in Avro schema.
  39. //
  40. // The Avro specification requires field names to be alphanumeric. By
  41. // default, in cases when column names do not conform to these requirements
  42. // (e.g. non-ascii unicode codepoints) and Avro is requested as an output
  43. // format, the CreateReadSession call will fail.
  44. //
  45. // Setting this field to true, populates avro field names with a placeholder
  46. // value and populates a "displayName" attribute for every avro field with the
  47. // original column name.
  48. bool enable_display_name_attribute = 1;
  49. }