Embulk を使用して Short.io のデータをデータベースにロードする方法

Embulk はオープンソースのバルクデータローダーです。CData API Driver for JDBC と組み合わせることで、Short.io から任意の同期先にデータを簡単にロードできます。この記事では、CData API Driver for JDBC をEmbulk で使用してShort.io のデータをMySQL データベースにロードする方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、リアルタイムのShort.io のデータに対して比類のないパフォーマンスを発揮します。Short.io に対して複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Short.io にプッシュし、サポートされていない操作（SQL 関数やJOIN 操作など）は組み込みのSQL エンジンを使用してクライアント側で処理します。

Short.io への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData API Driver for JDBC\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、Short.io に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、Short.io への認証用のJDBC URL を作成します。

API キー認証の設定

Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

1. Short.io アカウントにログインします
2. Settings > Integrations & API > API に移動します
3. Create API Key をクリックして API キーをコピーします

API キーを取得したら、接続を確立できます：

• AuthScheme：APIKey に設定します。
• APIKey：Settings > Integrations & API > API から取得した Short.io の API キーに設定します。

接続文字列の例：

Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

利用可能なテーブル

Short.io プロファイルでは、以下のテーブルにアクセスできます：

• Domains - 認証済みアカウントに関連付けられた Short.io ドメイン
• Links - ドメインの短縮リンク
• LinkExpand - ドメインとパスから短縮リンクを展開
• LinksByOriginalUrl - 指定した元の宛先 URL に一致する複数の短縮リンクを取得
• Folders - 特定のドメイン内のリンクフォルダー
• LinkPermissions - ドメイン内の特定のリンクの権限レコード
• CountryTargeting - 特定の短縮リンクの国別リダイレクトターゲティングルール
• RegionTargeting - 特定の短縮リンクの地域別リダイレクトターゲティングルール
• Regions - 指定した国コードに対する利用可能な地域／州の一覧
• DomainStatistics - Short.io ドメインのクリック数とトラフィックの集計統計
• LinkStatistics - 特定の Short.io リンクのクリック数とトラフィックの集計統計

組み込みの接続文字列デザイナー

JDBC URL の作成には、Short.io JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、Short.io への一般的なJDBC 接続文字列です。

jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Embulk で Short.io ののデータをロード

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してShort.io のデータをMySQL にロードする準備が整いました。

Short.io ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はapi-mysql.yml のようにします。

1. 入力プラグインのオプションには、CData API Driver for JDBC、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.api.APIDriver）、および上記のJDBC URL を指定します。
2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（api-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar
	driver_class: cdata.jdbc.api.APIDriver
	url: jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
	table: "Domains"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Domains"
	mode: insert

ファイルを作成したら、Embulk ジョブを実行します。

embulk run api-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにShort.io のデータが格納されます。

フィルタリングした Short.io ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar
	driver_class: cdata.jdbc.api.APIDriver
	url: jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
	query: "SELECT ,  FROM Domains WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Domains"
	mode: insert

詳細情報と無料トライアル

CData API Driver for JDBC をコネクタとして使用することで、Embulk のデータロードジョブにShort.io のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。