snippet_metadata.google.cloud.bigquery.storage.v1.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/bigquery/storage/apiv1",
    "version": "1.37.0",
    "language": "GO",
    "apis": [
      {
        "id": "google.cloud.bigquery.storage.v1",
        "version": "v1"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryRead_CreateReadSession_sync",
      "title": "bigquerystorage CreateReadSession Sample",
      "description": "CreateReadSession creates a new read session. A read session divides the contents of a\nBigQuery table into one or more streams, which can then be used to read\ndata from the table. The read session also specifies properties of the\ndata to be read, such as a list of columns or a push-down filter describing\nthe rows to be returned.\n\nA particular row can be read by at most one stream. When the caller has\nreached the end of each stream in the session, then all the data in the\ntable has been read.\n\nData is assigned to each stream such that roughly the same number of\nrows can be read from each stream. Because the server-side unit for\nassigning data is collections of rows, the API does not guarantee that\neach stream will return the same number or rows. Additionally, the\nlimits are enforced based on the number of pre-filtered rows, so some\nfilters can lead to lopsided assignments.\n\nRead sessions automatically expire 6 hours after they are created and do\nnot require manual clean-up by the caller.",
      "file": "BigQueryReadClient/CreateReadSession/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CreateReadSession",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryReadClient.CreateReadSession",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.CreateReadSessionRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.ReadSession",
        "client": {
          "shortName": "BigQueryReadClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryReadClient"
        },
        "method": {
          "shortName": "CreateReadSession",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryRead.CreateReadSession",
          "service": {
            "shortName": "BigQueryRead",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryRead"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryRead_ReadRows_sync",
      "title": "bigquerystorage ReadRows Sample",
      "description": "ReadRows reads rows from the stream in the format prescribed by the ReadSession.\nEach response contains one or more table rows, up to a maximum of 100 MiB\nper response; read requests which attempt to read individual rows larger\nthan 100 MiB will fail.\n\nEach request also returns a set of stream statistics reflecting the current\nstate of the stream.",
      "file": "BigQueryReadClient/ReadRows/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ReadRows",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryReadClient.ReadRows",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.ReadRowsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "client": {
          "shortName": "BigQueryReadClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryReadClient"
        },
        "method": {
          "shortName": "ReadRows",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryRead.ReadRows",
          "service": {
            "shortName": "BigQueryRead",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryRead"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 1,
          "end": -1,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryRead_SplitReadStream_sync",
      "title": "bigquerystorage SplitReadStream Sample",
      "description": "SplitReadStream splits a given ReadStream into two ReadStream objects. These\nReadStream objects are referred to as the primary and the residual\nstreams of the split. The original ReadStream can still be read from in\nthe same manner as before. Both of the returned ReadStream objects can\nalso be read from, and the rows returned by both child streams will be\nthe same as the rows read from the original stream.\n\nMoreover, the two child streams will be allocated back-to-back in the\noriginal ReadStream. Concretely, it is guaranteed that for streams\noriginal, primary, and residual, that original[0-j] = primary[0-j] and\noriginal[j-n] = residual[0-m] once the streams have been read to\ncompletion.",
      "file": "BigQueryReadClient/SplitReadStream/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "SplitReadStream",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryReadClient.SplitReadStream",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.SplitReadStreamRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.SplitReadStreamResponse",
        "client": {
          "shortName": "BigQueryReadClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryReadClient"
        },
        "method": {
          "shortName": "SplitReadStream",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryRead.SplitReadStream",
          "service": {
            "shortName": "BigQueryRead",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryRead"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryWrite_AppendRows_sync",
      "title": "bigquerystorage AppendRows Sample",
      "description": "AppendRows appends data to the given stream.\n\nIf offset is specified, the offset is checked against the end of\nstream. The server returns OUT_OF_RANGE in AppendRowsResponse if an\nattempt is made to append to an offset beyond the current end of the stream\nor ALREADY_EXISTS if user provides an offset that has already been\nwritten to. User can retry with adjusted offset within the same RPC\nconnection. If offset is not specified, append happens at the end of the\nstream.\n\nThe response contains an optional offset at which the append\nhappened.  No offset information will be returned for appends to a\ndefault stream.\n\nResponses are received in the same order in which requests are sent.\nThere will be one response for each successful inserted request.  Responses\nmay optionally embed error information if the originating AppendRequest was\nnot successfully processed.\n\nThe specifics of when successfully appended data is made visible to the\ntable are governed by the type of stream: \n\n  For COMMITTED streams (which includes the default stream), data is\n  visible immediately upon successful append.\n\n  For BUFFERED streams, data is made visible via a subsequent FlushRows\n  rpc which advances a cursor to a newer offset in the stream.\n\n  For PENDING streams, data is not made visible until the stream itself is\n  finalized (via the FinalizeWriteStream rpc), and the stream is explicitly\n  committed via the BatchCommitWriteStreams rpc.\n\nNote: For users coding against the gRPC api directly, it may be\nnecessary to supply the x-goog-request-params system parameter\nwith write_stream=<full_write_stream_name>.\n\nMore information about system parameters: \nhttps: //cloud.google.com/apis/docs/system-parameters (at https: //cloud.google.com/apis/docs/system-parameters)",
      "file": "BigQueryWriteClient/AppendRows/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "AppendRows",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient.AppendRows",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "client": {
          "shortName": "BigQueryWriteClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient"
        },
        "method": {
          "shortName": "AppendRows",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite.AppendRows",
          "service": {
            "shortName": "BigQueryWrite",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 63,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryWrite_BatchCommitWriteStreams_sync",
      "title": "bigquerystorage BatchCommitWriteStreams Sample",
      "description": "BatchCommitWriteStreams atomically commits a group of PENDING streams that belong to the same\nparent table.\n\nStreams must be finalized before commit and cannot be committed multiple\ntimes. Once a stream is committed, data in the stream becomes available\nfor read operations.",
      "file": "BigQueryWriteClient/BatchCommitWriteStreams/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "BatchCommitWriteStreams",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient.BatchCommitWriteStreams",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.BatchCommitWriteStreamsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.BatchCommitWriteStreamsResponse",
        "client": {
          "shortName": "BigQueryWriteClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient"
        },
        "method": {
          "shortName": "BatchCommitWriteStreams",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite.BatchCommitWriteStreams",
          "service": {
            "shortName": "BigQueryWrite",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryWrite_CreateWriteStream_sync",
      "title": "bigquerystorage CreateWriteStream Sample",
      "description": "CreateWriteStream creates a write stream to the given table.\nAdditionally, every table has a special stream named ‘_default’\nto which data can be written. This stream doesn’t need to be created using\nCreateWriteStream. It is a stream that can be used simultaneously by any\nnumber of clients. Data written to this stream is considered committed as\nsoon as an acknowledgement is received.",
      "file": "BigQueryWriteClient/CreateWriteStream/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CreateWriteStream",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient.CreateWriteStream",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.CreateWriteStreamRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.WriteStream",
        "client": {
          "shortName": "BigQueryWriteClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient"
        },
        "method": {
          "shortName": "CreateWriteStream",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite.CreateWriteStream",
          "service": {
            "shortName": "BigQueryWrite",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryWrite_FinalizeWriteStream_sync",
      "title": "bigquerystorage FinalizeWriteStream Sample",
      "description": "FinalizeWriteStream finalize a write stream so that no new data can be appended to the\nstream. Finalize is not supported on the ‘_default’ stream.",
      "file": "BigQueryWriteClient/FinalizeWriteStream/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "FinalizeWriteStream",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient.FinalizeWriteStream",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.FinalizeWriteStreamRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.FinalizeWriteStreamResponse",
        "client": {
          "shortName": "BigQueryWriteClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient"
        },
        "method": {
          "shortName": "FinalizeWriteStream",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite.FinalizeWriteStream",
          "service": {
            "shortName": "BigQueryWrite",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryWrite_FlushRows_sync",
      "title": "bigquerystorage FlushRows Sample",
      "description": "FlushRows flushes rows to a BUFFERED stream.\n\nIf users are appending rows to BUFFERED stream, flush operation is\nrequired in order for the rows to become available for reading. A\nFlush operation flushes up to any previously flushed offset in a BUFFERED\nstream, to the offset specified in the request.\n\nFlush is not supported on the _default stream, since it is not BUFFERED.",
      "file": "BigQueryWriteClient/FlushRows/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "FlushRows",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient.FlushRows",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.FlushRowsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.FlushRowsResponse",
        "client": {
          "shortName": "BigQueryWriteClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient"
        },
        "method": {
          "shortName": "FlushRows",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite.FlushRows",
          "service": {
            "shortName": "BigQueryWrite",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "bigquerystorage_v1_generated_BigQueryWrite_GetWriteStream_sync",
      "title": "bigquerystorage GetWriteStream Sample",
      "description": "GetWriteStream gets information about a write stream.",
      "file": "BigQueryWriteClient/GetWriteStream/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetWriteStream",
        "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient.GetWriteStream",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "storagepb.GetWriteStreamRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "storagepb.WriteStream",
        "client": {
          "shortName": "BigQueryWriteClient",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWriteClient"
        },
        "method": {
          "shortName": "GetWriteStream",
          "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite.GetWriteStream",
          "service": {
            "shortName": "BigQueryWrite",
            "fullName": "google.cloud.bigquery.storage.v1.BigQueryWrite"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 47,
          "type": "FULL"
        }
      ]
    }
  ]
}