バージョン: 1.8.4

Amazon Athena データソース

概要

Amazon Athena は、標準 SQL を使用して Amazon S3 内のデータを簡単に分析できるインタラクティブなクエリサービスです。このトピックでは、Reveal アプリケーションで Amazon Athena データソースに接続して、データを視覚化および分析する方法について説明します。

サーバーの構成

インストール

ASP.NET
Node.js
Java

ASP.NET アプリケーションの場合、Amazon Athena サポートを有効にするには、別の NuGet パッケージをインストールする必要があります。

dotnet add package Reveal.Sdk.Data.Amazon.Athena

次に、アプリケーションに Amazon Athena プロバイダーを登録します。

builder.Services.AddControllers().AddReveal( builder =>
{
    builder.DataSources.RegisterAmazonAthena();
});

接続の構成

Amazon Athena のすべての接続プロパティは、データソースプロバイダーの実装を通じてサーバー側で構成されます。

ASP.NET
Node.js
Node.js - TS
Java

// Create a data source provider
public class DataSourceProvider : IRVDataSourceProvider
{
    public async Task<RVDataSourceItem> ChangeDataSourceItemAsync(IRVUserContext userContext, string dashboardId, RVDataSourceItem dataSourceItem)
    {
        // Required: Update the underlying data source
        await ChangeDataSourceAsync(userContext, dataSourceItem.DataSource);

        if (dataSourceItem is RVAthenaDataSourceItem athenaItem)
        {            
            // Configure specific item properties as needed
            if (athenaItem.Id == "my-data-source-item")
            {
                athenaItem.Table = "your_table_name";
            }
        }
        
        return dataSourceItem;
    }

    public Task<RVDashboardDataSource> ChangeDataSourceAsync(IRVUserContext userContext, RVDashboardDataSource dataSource)
    {
        if (dataSource is RVAthenaDataSource athenaDS)
        {
            // Configure connection properties
            athenaDS.Region = "your_region";
            athenaDS.Database = "your_database_name";
        }
        
        return Task.FromResult(dataSource);
    }
}

// Create data source providers
const dataSourceItemProvider = async (userContext, dataSourceItem) => {
    // Required: Update the underlying data source
    await dataSourceProvider(userContext, dataSourceItem.dataSource);
    
    if (dataSourceItem instanceof reveal.RVAthenaDataSourceItem) {        
        // Configure specific item properties if needed
        if (dataSourceItem.id === "my-data-source-item") {
            dataSourceItem.table = "your_table_name";
        }
    }
    
    return dataSourceItem;
}

const dataSourceProvider = async (userContext, dataSource) => {
    if (dataSource instanceof reveal.RVAthenaDataSource) {
        // Configure connection properties
        dataSource.region = "your_region";
        dataSource.database = "your_database_name";
    }
    
    return dataSource;
}

// Create data source providers
const dataSourceItemProvider = async (userContext: IRVUserContext | null, dataSourceItem: RVDataSourceItem) => {
    // Required: Update the underlying data source
    await dataSourceProvider(userContext, dataSourceItem.dataSource);

    if (dataSourceItem instanceof RVAthenaDataSourceItem) {        
        // Configure specific item properties if needed
        if (dataSourceItem.id === "my-data-source-item") {
            dataSourceItem.table = "your_table_name";
        }
    }
    
    return dataSourceItem;
}

const dataSourceProvider = async (userContext: IRVUserContext | null, dataSource: RVDashboardDataSource) => {
    if (dataSource instanceof RVAthenaDataSource) {
        // Configure connection properties
        dataSource.region = "your_region";
        dataSource.database = "your_database_name";
    }
    
    return dataSource;
}

// Create a data source provider
public class DataSourceProvider implements IRVDataSourceProvider {

    public RVDataSourceItem changeDataSourceItem(IRVUserContext userContext, String dashboardId, RVDataSourceItem dataSourceItem) {
        // Required: Update the underlying data source
        changeDataSource(userContext, athenaItem.getDataSource());

        if (dataSourceItem instanceof RVAthenaDataSourceItem athenaItem) {            
            // Configure specific item properties if needed
            if ("my-data-source-item".equals(athenaItem.getId())) {
                athenaItem.setTable("your_table_name");
            }
        }
        
        return dataSourceItem;
    }

    public RVDashboardDataSource changeDataSource(IRVUserContext userContext, RVDashboardDataSource dataSource) {
        if (dataSource instanceof RVAthenaDataSource athenaDS) {
            // Configure connection properties
            athenaDS.setRegion("your_region");
            athenaDS.setDatabase("your_database_name");
        }
        
        return dataSource;
    }
}

Important

ChangeDataSourceAsync メソッドでデータソースに加えられた変更は、ChangeDataSourceItemAsync メソッドには引き継がれません。どちらの方法でも、データソースプロパティを更新する必要があります。上記の例に示すように、ChangeDataSourceItemAsync メソッド内で ChangeDataSourceAsync メソッドを呼び出し、データソース項目の基になるデータソースをパラメーターとして渡すことをお勧めします。

認証

Amazon Athena の認証は、AWS 認証情報を使用してサーバー側で処理されます。認証オプションの詳細については、「認証」トピックを参照してください。

ASP.NET
Node.js
Node.js - TS
Java

public class AuthenticationProvider: IRVAuthenticationProvider
{
    public Task<IRVDataSourceCredential> ResolveCredentialsAsync(IRVUserContext userContext, RVDashboardDataSource dataSource)
    {
        IRVDataSourceCredential userCredential = null;
        if (dataSource is RVS3DataSource)
        {
            userCredential = new RVAmazonWebServicesCredentials("key", "secret");
        }
        return Task.FromResult<IRVDataSourceCredential>(userCredential);
    }
}

const authenticationProvider = async (userContext, dataSource) => {
    if (dataSource instanceof reveal.RVS3DataSource) {
        return new reveal.RVAmazonWebServicesCredentials("key", "secret");
    }
    return null;
}

const authenticationProvider = async (userContext:IRVUserContext | null, dataSource: RVDashboardDataSource) => {
    if (dataSource instanceof RVS3DataSource) {
        return new RVAmazonWebServicesCredentials("key", "secret");
    }
    return null;
}

public class AuthenticationProvider implements IRVAuthenticationProvider {
    @Override
    public IRVDataSourceCredential resolveCredentials(IRVUserContext userContext, RVDashboardDataSource dataSource) {
        if (dataSource instanceof RVS3DataSource) {
            return new RVAmazonWebServicesCredentials("key", "secret");
        }
        return null;
    }
}

クライアント側の実装

クライアント側では、データソースの ID、タイトル、サブタイトルなどの基本プロパティを指定するだけです。実際の接続構成はサーバー上で行われます。

データソースの作成

手順 1 - RevealView.onDataSourcesRequested イベントのイベントハンドラーを追加します。

const revealView = new $.ig.RevealView("#revealView");
revealView.onDataSourcesRequested = (callback) => {
    // Add data source here
    callback(new $.ig.RevealDataSources([], [], false));
};

手順 2 - RevealView.onDataSourcesRequested イベントハンドラーで、RVAthenaDataSource オブジェクトの新しいインスタンスを作成します。title と subtitle プロパティを設定します。RVAthenaDataSource オブジェクトを作成したら、それをデータソースコレクションに追加します。

revealView.onDataSourcesRequested = (callback) => {
    const athenaDS = new $.ig.RVAthenaDataSource();
    athenaDS.title = "My Athena Data Source";
    athenaDS.subtitle = "Amazon Athena";

    callback(new $.ig.RevealDataSources([athenaDS], [], false));
};

アプリケーションが実行されたら、新しい可視化を作成すると、新しく作成された Amazon Athena データソースが [データソースの選択] ダイアログにリストされます。

データソース項目の作成

データソース項目は、ユーザーが表示形式のために選択できる Athena データソース内の特定のデータセットを表します。クライアント側では、ID、タイトル、サブタイトルを指定するだけです。

revealView.onDataSourcesRequested = (callback) => {
    // Create the data source
    const athenaDS = new $.ig.RVAthenaDataSource();
    athenaDS.title = "My Athena Data Source";
    athenaDS.subtitle = "Amazon Athena";
    
    // Create a data source item
    const athenaDSI = new $.ig.RVAthenaDataSourceItem(athenaDS);
    athenaDSI.id = "my-data-source-item";
    athenaDSI.title = "My Athena Data Source Item";
    athenaDSI.subtitle = "Amazon Athena";

    callback(new $.ig.RevealDataSources([athenaDS], [athenaDSI], false));
};

アプリケーションが実行されたら、新しい可視化を作成すると、新しく作成された Amazon Athena データソース項目が [データソースの選択] ダイアログにリストされます。

その他のリソース

API リファレンス

ASP.NET
Node.js
Java

RVAthenaDataSource - Amazon Athena データソースを表します
RVAthenaDataSourceItem - Amazon Athena データソース項目を表します

概要​

サーバーの構成​

インストール​

接続の構成​

認証​

クライアント側の実装​

データ ソースの作成​

データ ソース項目の作成​

その他のリソース​

API リファレンス​

概要