Method: routines.list

Lists all routines in the specified dataset. Requires the READER dataset role.

HTTP request

GET https://bigquery.googleapis.com/bigquery/v2/projects/{projectId}/datasets/{datasetId}/routines

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. Project ID of the routines to list

datasetId

string

Required. Dataset ID of the routines to list

Query parameters

Parameters
maxResults

integer

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

pageToken

string

Page token, returned by a previous call, to request the next page of results

readMask

string (FieldMask format)

If set, then only the Routine fields in the field mask, as well as projectId, datasetId and routineId, are returned in the response. If unset, then the following Routine fields are returned: etag, projectId, datasetId, routineId, routineType, creationTime, lastModifiedTime, and language.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

filter

string

If set, then only the Routines matching this filter are returned. The current supported form is either "routineType:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "routines": [
    {
      object (Routine)
    }
  ],
  "nextPageToken": string
}
Fields
routines[]

object (Routine)

Routines in the requested dataset. Unless readMask is set in the request, only the following fields are populated: etag, projectId, datasetId, routineId, routineType, creationTime, lastModifiedTime, and language.

nextPageToken

string

A token to request the next page of results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/bigquery.readonly
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.

Try it!