модуль google.cloud.gcp_bigquery_table_info — сбор информации о таблице GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_bigquery_table_info.
Краткое описание
- Сбор информации о таблице GCP
Требования
На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
dataset string | Название набора данных. |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для запросов API. |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / elements=string | Массив областей доступа для использования |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды используются только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: get info on a table
gcp_bigquery_table_info:
dataset: example_dataset
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
clustering list / elements=string |
Одно или несколько полей, по которым следует кластеризовать данные. Поддерживаются только поля верхнего уровня, не являющиеся повторяющимися и имеющие простой тип. При кластеризации таблицы по нескольким столбцам важен указанный вами порядок столбцов. Порядок указанных столбцов определяет порядок сортировки данных. Возвращается: при успешном выполнении |
|
creationTime integer |
Время создания этого набора данных в миллисекундах с начала эпохи. Возвращается: при успешном выполнении |
|
dataset string |
Имя набора данных. Возвращается: при успешном выполнении |
|
description string |
Удобное для пользователя описание набора данных. Возвращается: при успешном выполнении |
|
encryptionConfiguration complex |
Пользовательская конфигурация шифрования. Возвращается: при успешном выполнении |
|
kmsKeyName string |
Описывает ключ шифрования Cloud KMS, который будет использоваться для защиты целевой таблицы BigQuery. Сервисному аккаунту BigQuery, связанному с вашим проектом, необходим доступ к этому ключу шифрования. Возвращается: при успешном выполнении |
|
expirationTime integer |
Время истечения срока действия этой таблицы в миллисекундах с начала эпохи. Если значение не указано, таблица будет храниться неограниченно долго. Возвращается: при успешном выполнении |
|
externalDataConfiguration complex |
Описывает формат данных, расположение и другие свойства таблицы, хранящейся за пределами BigQuery. После определения этих свойств к источнику данных можно обращаться с запросами так, как если бы это была обычная таблица BigQuery. Возвращается: при успешном выполнении |
|
autodetect boolean |
Автоматически определить схему и параметры формата. Все явно заданные параметры будут учтены. Возвращается: при успешном выполнении |
|
bigtableOptions complex |
Дополнительные параметры, если для sourceFormat задано значение BIGTABLE. Возвращается: при успешном выполнении |
|
columnFamilies complex |
Список семейств столбцов, которые нужно представить в схеме таблицы, вместе с их типами. Возвращается: при успешном выполнении |
|
columns complex |
Списки столбцов, которые следует представить в виде отдельных полей, а не списка пар (имя столбца, значение). Возвращается: при успешном выполнении |
|
encoding string |
Кодировка значений, если их тип не STRING. Возвращается: при успешном выполнении |
|
fieldName string |
Если квалификатор не является допустимым идентификатором поля BigQuery, необходимо указать допустимый идентификатор в качестве имени поля столбца. Это имя будет использоваться как имя поля в запросах. Возвращается: при успешном выполнении |
|
onlyReadLatest boolean |
Если этот параметр задан, будет предоставляться только последняя версия значения в этом столбце. Возвращается: при успешном выполнении |
|
qualifierString string |
Квалификатор столбца. Возвращается: при успешном выполнении |
|
type string |
Тип, к которому преобразуется значение в ячейках этого столбца. Возвращается: при успешном выполнении |
|
encoding string |
Кодировка значений, если их тип не STRING. Возвращается: при успешном выполнении |
|
familyId string |
Идентификатор семейства столбцов. Возвращается: при успешном выполнении |
|
onlyReadLatest boolean |
Если этот параметр задан, для всех столбцов этого семейства столбцов будет предоставляться только последняя версия значения. Возвращается: при успешном выполнении |
|
type string |
Тип, к которому преобразуется значение в ячейках этого семейства столбцов. Возвращается: при успешном выполнении |
|
ignoreUnspecifiedColumnFamilies boolean |
Если значение поля равно true, семейства столбцов, не указанные в списке columnFamilies, не будут представлены в схеме таблицы. Возвращается: при успешном выполнении |
|
readRowkeyAsString boolean |
Если значение поля равно true, семейства столбцов с ключом строки будут считаны и преобразованы в строку. Возвращается: при успешном выполнении |
|
compression string |
Тип сжатия источника данных. Возвращается: при успешном выполнении |
|
csvOptions complex |
Дополнительные свойства, задаваемые, если для sourceFormat указано значение CSV. Возвращается: при успешном выполнении |
|
allowJaggedRows boolean |
Указывает, должен ли BigQuery принимать строки, в которых отсутствуют завершающие необязательные столбцы. Возвращается: при успешном выполнении |
|
allowQuotedNewlines boolean |
Указывает, должен ли BigQuery разрешать наличие символов новой строки в заключённых в кавычки фрагментах данных CSV-файла. Возвращается: при успешном выполнении |
|
encoding string |
Кодировка символов данных. Возвращается: при успешном выполнении |
|
fieldDelimiter string |
Разделитель полей в CSV-файле. Возвращается: при успешном выполнении |
|
quote string |
Символ, используемый для заключения фрагментов данных CSV-файла в кавычки. Возвращается: при успешном выполнении |
|
skipLeadingRows integer |
Количество строк в начале CSV-файла, которые BigQuery пропустит при чтении данных. Возвращается: при успешном выполнении |
|
googleSheetsOptions complex |
Дополнительные параметры, если для sourceFormat задано значение GOOGLE_SHEETS. Возвращается: при успешном выполнении |
|
skipLeadingRows integer |
Количество строк в начале таблицы Google Sheets, которые BigQuery пропустит при чтении данных. Возвращается: при успешном выполнении |
|
ignoreUnknownValues boolean |
Указывает, должен ли BigQuery разрешать наличие дополнительных значений, не представленных в схеме таблицы. Возвращается: при успешном выполнении |
|
maxBadRecords integer |
Максимальное количество некорректных записей, которые BigQuery может игнорировать при чтении данных. Возвращается: при успешном выполнении |
|
schema complex |
Схема данных. Схема обязательна для форматов CSV и JSON. Возвращается: при успешном выполнении |
|
fields complex |
Описывает поля таблицы. Возвращается: при успешном выполнении |
|
description string |
Описание поля. Возвращается: при успешном выполнении |
|
fields list / elements=string |
Описывает вложенные поля схемы, если для свойства type задано значение RECORD. Возвращается: при успешном выполнении |
|
mode string |
Режим поля. Возвращается: при успешном выполнении |
|
name string |
Имя поля. Возвращается: при успешном выполнении |
|
type string |
Тип данных поля. Возвращается: при успешном выполнении |
|
sourceFormat string |
Формат данных. Возвращается: при успешном выполнении |
|
sourceUris list / elements=string |
Полные URI, указывающие на ваши данные в Google Cloud. Для URI Google Cloud Storage: каждый URI может содержать один подстановочный символ «*», который должен располагаться после имени «bucket». К внешним источникам данных применяются ограничения на размер, связанные с заданиями загрузки. Для URI Google Cloud Bigtable: можно указать ровно один URI; это должен быть полный и допустимый HTTPS URL таблицы Google Cloud Bigtable. Для резервных копий Google Cloud Datastore можно указать ровно один URI. Кроме того, подстановочный символ «*» использовать нельзя. Возвращается: при успешном выполнении |
|
friendlyName string |
Понятное имя этой таблицы. Возвращается: при успешном выполнении |
|
id string |
Непрозрачный идентификатор, однозначно определяющий таблицу. Возвращается: при успешном выполнении |
|
labels dictionary |
Метки, связанные с этим набором данных. Их можно использовать для упорядочивания наборов данных и объединения их в группы. Возвращается: при успешном выполнении |
|
lastModifiedTime integer |
Время последнего изменения этой таблицы в миллисекундах с начала эпохи. Возвращается: при успешном выполнении |
|
location string |
Географическое расположение таблицы. Это значение наследуется от набора данных. Возвращается: при успешном выполнении |
|
name string |
Имя таблицы. Возвращается: при успешном выполнении |
|
numBytes integer |
Размер этой таблицы в байтах, не включая данные в буфере потоковой передачи. Возвращается: при успешном выполнении |
|
numLongTermBytes integer |
Количество байтов в таблице, которые считаются данными «долгосрочного хранения». Возвращается: при успешном выполнении |
|
numRows integer |
Количество строк данных в этой таблице, не включая данные в буфере потоковой передачи. Возвращается: при успехе |
|
requirePartitionFilter boolean |
Если установлено значение true, для запросов к этой таблице необходимо указать фильтр разделов, который можно использовать для исключения разделов. Возвращается: при успехе |
|
schema complex |
Описывает схему этой таблицы. Возвращается: при успехе |
|
fields complex |
Описывает поля таблицы. Возвращается: при успехе |
|
description string |
Описание поля. Максимальная длина — 1 024 символа. Возвращается: при успехе |
|
fields list / elements=string |
Описывает вложенные поля схемы, если для свойства type задано значение RECORD. Возвращается: при успехе |
|
mode string |
Режим поля. Возвращается: при успехе |
|
name string |
Имя поля. Возвращается: при успехе |
|
type string |
Тип данных поля. Возвращается: при успехе |
|
streamingBuffer complex |
Содержит информацию о буфере потоковой передачи этой таблицы, если он существует. Это поле отсутствует, если в таблицу не выполняется потоковая передача или буфер потоковой передачи пуст. Возвращается: при успехе |
|
estimatedBytes integer |
Нижняя оценка количества байтов, находящихся в данный момент в буфере потоковой передачи. Возвращается: при успехе |
|
estimatedRows integer |
Нижняя оценка количества строк, находящихся в данный момент в буфере потоковой передачи. Возвращается: при успехе |
|
oldestEntryTime integer |
Если буфер потоковой передачи доступен, содержит временную метку самой старой записи в буфере в миллисекундах с начала эпохи. Возвращается: при успехе |
|
tableReference complex |
Ссылка с идентификатором этой таблицы. Возвращается: при успехе |
|
datasetId string |
Идентификатор набора данных, содержащего эту таблицу. Возвращается: при успехе |
|
projectId string |
Идентификатор проекта, содержащего эту таблицу. Возвращается: при успехе |
|
tableId string |
Идентификатор таблицы. Возвращается: при успехе |
|
timePartitioning complex |
Если параметр задан, настраивает разбиение этой таблицы на разделы по времени. Возвращается: при успехе |
|
expirationMs integer |
Количество миллисекунд, в течение которых следует хранить данные раздела. Возвращается: при успехе |
|
field string |
Если параметр не задан, таблица разбивается на разделы по псевдостолбцу, доступному как ‘_PARTITIONTIME’ с типом TIMESTAMP или как ‘_PARTITIONDATE’ с типом DATE. Если задано поле, таблица разбивается на разделы по этому полю. Поле должно быть полем TIMESTAMP или DATE верхнего уровня. Его режим должен быть NULLABLE или REQUIRED. Возвращается: при успехе |
|
type string |
Поддерживается только тип DAY, который создает один раздел на каждый день. Возвращается: при успехе |
|
type string |
Описывает тип таблицы. Возвращается: при успехе |
|
view complex |
Определение представления. Возвращается: при успехе |
|
useLegacySql boolean |
Указывает, следует ли использовать в этом представлении устаревший диалект SQL BigQuery. Возвращается: при успехе |
|
userDefinedFunctionResources complex |
Описывает ресурсы пользовательских функций, используемые в запросе. Возвращается: при успехе |
|
inlineCode string |
Встроенный ресурс с кодом пользовательской функции (UDF). Передача встроенного ресурса с кодом эквивалентна передаче URI файла с тем же кодом. Возвращается: при успехе |
|
resourceUri string |
Ресурс с кодом, загружаемый из URI Google Cloud Storage (gs://bucket/path). Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_bigquery_table_info_module.html