Explorar um banco de dados usando o Flow Service API

Este tutorial usa o Flow Service API para explorar o conteúdo e a estrutura de arquivos de um banco de dados de terceiros.

Introdução

Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito a um banco de dados de terceiros usando o Flow Service API.

Coletar credenciais necessárias

Este tutorial requer uma conexão válida com o banco de dados de terceiros do qual você deseja assimilar dados. Uma conexão válida envolve a ID da especificação da conexão do banco de dados e a ID da conexão. Mais informações sobre como criar uma conexão de banco de dados e recuperar esses valores podem ser encontradas na seção visão geral dos conectores de origem.

Leitura de chamadas de API de amostra

Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O exemplo de JSON retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no Experience Platform guia de solução de problemas.

Coletar valores para cabeçalhos obrigatórios

Para fazer chamadas para Platform APIs, primeiro conclua o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todos os Experience Platform Chamadas de API, conforme mostrado abaixo:

Todos os recursos em Experience Platform, incluindo as que pertencem a Flow Service, são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

Todas as solicitações que contêm uma carga (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:

Explore suas tabelas de dados

Usando a ID de conexão do banco de dados, você pode explorar as tabelas de dados executando solicitações do GET. Use a chamada a seguir para encontrar o caminho da tabela que você deseja inspecionar ou assimilar Platform.

Formato da API

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

Solicitação

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=root' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta

Uma resposta bem-sucedida retorna uma matriz de tabelas do banco de dados. Encontre a tabela que deseja trazer para Platform e toma nota da sua path propriedade, conforme necessário fornecê-la na próxima etapa para inspecionar sua estrutura.

[
    {
        "type": "table",
        "name": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect a estrutura de uma tabela

Para inspecionar a estrutura de uma tabela do banco de dados, execute uma solicitação GET enquanto especifica o caminho de uma tabela como um parâmetro de consulta.

Formato da API

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

Solicitação

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta

Uma resposta bem-sucedida retorna a estrutura da tabela especificada. Detalhes sobre cada coluna da tabela estão localizados em elementos do columns matriz.

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

Próximas etapas

Seguindo este tutorial, você explorou seu banco de dados, encontrou o caminho da tabela na qual deseja assimilar Platforme obteve informações sobre a sua estrutura. Você pode usar essas informações no próximo tutorial para coletar dados do banco de dados e trazê-los para a Platform.