gcp_bigquery_table_info – Сбор информации о таблице GCP

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Сбор информации о таблице GCP
Этот модуль назывался gcp_bigquery_table_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_bigquery_table_facts

Требования

Ниже перечислены требования, которые необходимы на хосте, выполняющем этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
dataset строка		Имя набора данных.
env_type строка		Указывает, в какой среде Ansible вы запускаете этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API.
project строка		Проект Google Cloud Platform, который нужно использовать.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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					успех	Один или несколько полей, по которым должны быть сгруппированы данные. Поддерживаются только поля верхнего уровня, не повторяющиеся и простого типа. При группировке таблицы по нескольким столбцам порядок указанных столбцов имеет значение. Порядок указанных столбцов определяет порядок сортировки данных.
	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, то семейства столбцов rowkey будут читаться и преобразовываться в строку.
		compression string				успех	Тип сжатия источника данных.
		csvOptions complex				успех	Дополнительные свойства, которые необходимо установить, если sourceFormat установлен в CSV.
			allowJaggedRows boolean			успех	Указывает, должно ли приложение BigQuery принимать строки, у которых отсутствуют заключительные необязательные столбцы.
			allowQuotedNewlines boolean			успех	Указывает, должны ли разрешаться цитируемые разделы данных, содержащие символы новой строки, в CSV-файле.
			encoding string			успех	Кодировка символов данных.
			fieldDelimiter string			успех	Разделитель полей в CSV-файле.
			quote string			успех	Значение, используемое для цитирования разделов данных в CSV-файле.
			skipLeadingRows integer			успех	Количество строк в верхней части CSV-файла, которые BigQuery пропустит при чтении данных.

	googleSheetsOptions complex			success	Дополнительные параметры, если sourceFormat установлен в GOOGLE_SHEETS.
		skipLeadingRows integer		success	Количество строк вверху Google Таблицы, которые BigQuery пропустит при чтении данных.
	ignoreUnknownValues boolean			success	Указывает, разрешает ли BigQuery дополнительные значения, которые не представлены в схеме таблицы.
	maxBadRecords integer			success	Максимальное количество плохих записей, которые BigQuery может пропустить при чтении данных.
	schema complex			success	Схема данных. Схема требуется для форматов CSV и JSON.
		fields complex		success	Описание полей в таблице.
			description string	success	Описание поля.
			fields list	success	Описание вложенных полей схемы, если свойство type установлено в RECORD.
			mode string	success	Режим поля.
			name string	success	Имя поля.
			type string	success	Тип данных поля.
	sourceFormat string			success	Формат данных.
	sourceUris list			success	Полные URI, указывающие на ваши данные в Google Cloud. Для URI Google Cloud Storage: Каждый URI может содержать один символ «» в качестве подстановки, и он должен стоять после имени «bucket». Ограничения по размеру, связанные с заданиями загрузки, относятся к внешним источникам данных. Для URI Google Cloud Bigtable: Должен быть указан ровно один URI, и это должна быть полная и допустимая HTTPS-ссылка на таблицу Google Cloud Bigtable. Для резервных копий Google Cloud Datastore можно указать ровно один URI. Также символ «» в качестве подстановки недопустим.
friendlyName string				success	Дескриптивное имя для этой таблицы.
id string				success	Уникальный идентификатор таблицы.
labels dictionary				success	Метки, связанные с этим набором данных. Вы можете использовать их для организации и группировки наборов данных.
lastModifiedTime integer				success	Время последнего изменения этой таблицы в миллисекундах с начала эпохи.
location string				success	Географическое расположение, где находится таблица. Это значение наследуется от набора данных.
name string				success	Имя таблицы.
numBytes integer				success	Размер этой таблицы в байтах, исключая любые данные в буфере потоковой передачи.
numLongTermBytes integer				success	Количество байтов в таблице, которые считаются хранящимися в долгосрочном хранилище.
numRows integer				success	Количество строк данных в этой таблице, исключая любые данные в буфере потоковой передачи.
requirePartitionFilter boolean				success	Если установлено в true, запросы к этой таблице требуют фильтра разделов, который можно использовать для устранения разделов.
schema complex				success	Описание схемы этой таблицы.
	fields complex			success	Описание полей в таблице.
		description string		success	Описание поля. Максимальная длина — 1024 символа.
		fields list		success	Описание вложенных полей схемы, если свойство type установлено в RECORD.
		mode string		success	Режим поля.
		name string		success	Имя поля.
		type string		success	Тип данных поля.
streamingBuffer complex				success	Содержит информацию о буфере потоковой передачи этой таблицы, если он есть. Это поле отсутствует, если таблица не передается в потоковом режиме или если в буфере потоковой передачи нет данных.
	estimatedBytes integer			success	Нижняя оценка количества байтов, которые в настоящее время находятся в буфере потоковой передачи.
	estimatedRows integer			success	Нижняя оценка количества строк, которые в настоящее время находятся в буфере потоковой передачи.
	oldestEntryTime integer			success	Содержит метку времени самой старой записи в буфере потоковой передачи (в миллисекундах с начала эпохи), если буфер потоковой передачи доступен.
tableReference complex				success	Ссылка, описывающая идентификатор этой таблицы.
	datasetId string			success	Идентификатор набора данных, содержащего эту таблицу.

	projectId строка		успех	Идентификатор проекта, содержащего эту таблицу.
	tableId строка		успех	Идентификатор таблицы.
timePartitioning сложный тип			успех	Если указано, настраивает временное разбиение для этой таблицы.
	expirationMs целое число		успех	Количество миллисекунд, в течение которых хранится разбиение.
	field строка		успех	Если не задано, таблица разбивается по псевдостолбцу, который ссылается на '_PARTITIONTIME' как тип TIMESTAMP или '_PARTITIONDATE' как тип DATE. Если поле задано, таблица разбивается по этому полю. Поле должно быть верхнеуровневым полем TIMESTAMP или DATE. Его режим должен быть NULLABLE или REQUIRED.
	type строка		успех	Поддерживается только тип DAY, который создаст одно разбиение на каждый день.
type строка			успех	Описывает тип таблицы.
view сложный тип			успех	Определение представления.
	useLegacySql логическое		успех	Указывает, использовать ли BigQuery legacy SQL для этого представления.
	userDefinedFunctionResources сложный тип		успех	Описывает ресурсы пользовательских функций, используемые в запросе.
		inlineCode строка	успех	Встроенный ресурс, содержащий код для пользовательской функции (UDF). Предоставление встроенного кода равносильно предоставлению URI для файла, содержащего тот же код.
		resourceUri строка	успех	Ресурс кода для загрузки из URI Google Cloud Storage (gs://bucket/path).

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_bigquery_table_info_module.html