Коннектор "Снежинка

Запрос информации из Snowflake для использования в приложениях Tulip

Аудитория

Обратите внимание, что интеграция со Snowflake является технической и может потребовать от вашей ИТ-поддержки создания соответствующих объектов, ролей и разрешений.

Контактное лицо службы поддержки

Этот коннектор был создан в сотрудничестве с компанией Spaulding Ridge. Для получения дополнительной информации или вопросов обращайтесь в Spaulding Ridge по адресу info@spauldingridge.com.

Назначение

Коннектор Snowflake упрощает процесс запроса информации из облака данных Snowflake. Документацию по Snowflake SQL REST API можно найти здесь.

Примечания к коннектору

Коннектор Snowflake может относительно легко манипулировать отдельными записями. Для запросов к нескольким строкам данных или манипуляций с выходными данными в Tulip (интерактивная таблица и т. д.) могут потребоваться пользовательские виджеты.

Snowflake OAuth использует встроенный в Snowflake сервис OAuth и поддерживает Tulip в качестве пользовательского клиента. Документацию по Snowflake OAuth можно найти здесь. Подробности настройки пользовательского клиента можно найти здесь.

Настройка

В этом разделе описана процедура настройки OAuth-токена с OAuth-сервера Snowflake для установления соединения с Tulip в качестве клиента, а также шаги по настройке коннектора Snowflake в Tulip.

Шаг 1: Зарегистрируйте Tulip в качестве клиентского приложения в Snowflake

Войдите в свой экземпляр Snowflake под пользователем, имеющим роль/привилегии для создания и управления интеграциями безопасности (ACCOUNTADMIN).

Создайте новую рабочую таблицу SQL в хранилище COMPUTE_WH.

Запустите следующий сценарий, чтобы создать интеграцию безопасности типа OAuth. Не забудьте обновить значения INTEGRATION_NAME, TULIP_INSTANCE_NAME и TIME_IN_SECONDS.

СОЗДАТЬ ИЛИ ЗАМЕНИТЬ ИНТЕГРАЦИЮ БЕЗОПАСНОСТИ <ИМЯ_ИНТЕГРАЦИИ> TYPE = OAUTH ENABLED = TRUE OAUTH_CLIENT = CUSTOM OAUTH_CLIENT_TYPE = 'CONFIDENTIAL' OAUTH_REDIRECT_URI = 'https://<TULIP_INSTANCE_NAME>.tulip.co/oauth-redirect-handler' OAUTH_ISSUE_REFRESH_TOKENS = TRUE OAUTH_ISSUE_REFRESH_TOKEN_VALIDITY = <TIME_IN_SECONDS>;

Примечание: срок действия Refresh Token может составлять 90 дней (7776000 секунд).

Шаг 2: Соберите детали для конфигурации OAuth в Tulip

Выполните следующие команды для описания только что созданной интеграции безопасности и запишите следующие данные: OAUTH_CLIENT_ID OAUTH_REDIRECT_URI OAUTH_AUTHORIZATION_ENDPOINT OAUTH_TOKEN_ENDPOINT OAUTH_CLIENT_SECRET

ОПИШИТЕ ИНТЕГРАЦИЮ БЕЗОПАСНОСТИ ; ВЫБЕРИТЕ SYSTEM$SHOW_OAUTH_CLIENT_SECRETS('');

Шаг 3: Настройте коннектор Snowflake

Войдите в Tulip и добавьте коннектор Snowflake из библиотеки Tulip (Web или Embedded).

Нажмите кнопку "Производство, тестирование и разработка", чтобы отредактировать детали подключения, как показано ниже. Вы можете найти свое SNOWFLAKE_ACCOUNT_NAME в OAUTH_AUTHORIZATION_ENDPOINT или OAUTH_TOKEN_ENDPOINT из Шага 2.

Нажмите "Проверить" и "Сохранить". Коннектор перейдет в режим онлайн.

Шаг 4: Редактирование сведений об аутентификации коннектора Snowflake

Нажмите кнопку "Производство, тестирование и разработка" и кнопку "Редактировать заголовки".

Выберите тип аутентификации: "OAuth 2 (Admin)" или "OAuth 2 (Operator)" в зависимости от ваших требований. Дополнительную информацию об этом можно найти в разделе "Аутентификация" статьи "Как настроить коннектор".

Отредактируйте поля аутентификации, используя данные из шага 2: Код авторизации URL = OAUTH_AUTHORIZATION_ENDPOINT Токен доступа URL = OAUTH_TOKEN_ENDPOINT ID клиента = OAUTH_CLIENT_ID Client Secret = OAUTH_CLIENT_SECRET

Нажмите "Проверить". Вы попадете в окно входа в учетную запись Snowflake.

Пользователь должен войти в систему. Обратите внимание, что его роль по умолчанию не должна быть ACCOUNTADMIN, SECURITYADMIN или ORGADMIN. Вы можете изменить роль пользователя по умолчанию для OAuth, как подробно описано в этом ресурсе Snowflake: Управление согласием пользователей для OAuth.

После успешной аутентификации появится сообщение для получения согласия. Пожалуйста, внимательно прочитайте его, чтобы понять, какая операция выполняется, и нажмите "Разрешить". Теперь вы можете безопасно подключаться к Snowflake из Tulip!

Использование

У вас есть два варианта начала использования коннектора:

Начните с настройки функций шаблона коннектора в соответствии с вашими конкретными требованиями.

Следуйте инструкциям Snowflake Unit Test, чтобы на практике продемонстрировать, как использовать коннектор для решения таких задач, как получение всех записей таблицы Snowflake Table в Tulip, создание новой записи, обновление существующей записи и удаление записи.

Функции шаблонов

Коннектор Library включает следующие функции шаблонов: Шаблон: Запрос к базе данных Описание: Позволяет отправить на выполнение один или несколько SQL-запросов. Метод: POST Конечная точка: /api/v2/statements Ссылка: https://docs.snowflake.com/en/developer-guide/sql-api/reference#post-api-v2-statements Шаблон: Check Query Status Описание: Позволяет проверить статус выполнения запроса. Метод: GET Конечная точка: /api/v2/statements/{statementHandle} Ссылка: https://docs.snowflake.com/en/developer-guide/sql-api/reference#get-api-v2-statements-statementhandle Шаблон: Cancel Query Описание: Позволяет отменить выполнение запроса. Метод: POST Конечная точка: /api/v2/statements/{statementHandle}/cancel Ссылка: https://docs.snowflake.com/en/developer-guide/sql-api/reference#post-api-v2-statements-statementhandle-cancel

Дополнительные ссылки

Это руководство сообщества Snowflake также содержит дополнительные сведения об интеграции Snowflake