> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-trino-dialect.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ClickHouse と Amazon Glue を統合する

# Amazon Glue を ClickHouse および Spark と統合する

export const ClickHouseSupportedBadge = () => {
  return <div className="ClickHouseSupportedBadge">
            <div className="ClickHouseSupportedIcon">
                <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                    <path d="M1.30762 1.39073C1.30762 1.3103 1.37465 1.22986 1.46849 1.22986H2.64824C2.72868 1.22986 2.80912 1.29689 2.80912 1.39073V14.4886C2.80912 14.5691 2.74209 14.6495 2.64824 14.6495H1.46849C1.38805 14.6495 1.30762 14.5825 1.30762 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M4.2832 1.39073C4.2832 1.3103 4.35023 1.22986 4.44408 1.22986H5.62383C5.70427 1.22986 5.7847 1.29689 5.7847 1.39073V14.4886C5.7847 14.5691 5.71767 14.6495 5.62383 14.6495H4.44408C4.36364 14.6495 4.2832 14.5825 4.2832 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M7.25977 1.39073C7.25977 1.3103 7.3268 1.22986 7.42064 1.22986H8.60039C8.68083 1.22986 8.76127 1.29689 8.76127 1.39073V14.4886C8.76127 14.5691 8.69423 14.6495 8.60039 14.6495H7.42064C7.3402 14.6495 7.25977 14.5825 7.25977 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M10.2354 1.39073C10.2354 1.3103 10.3024 1.22986 10.3962 1.22986H11.576C11.6564 1.22986 11.7369 1.29689 11.7369 1.39073V14.4886C11.7369 14.5691 11.6698 14.6495 11.576 14.6495H10.3962C10.3158 14.6495 10.2354 14.5825 10.2354 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M13.2256 6.6057C13.2256 6.52526 13.2926 6.44482 13.3865 6.44482H14.5662C14.6466 6.44482 14.7271 6.51186 14.7271 6.6057V9.27354C14.7271 9.35398 14.6601 9.43442 14.5662 9.43442H13.3865C13.306 9.43442 13.2256 9.36739 13.2256 9.27354V6.6057Z" fill="currentColor" />
                </svg>
            </div>
            ClickHouse対応
        </div>;
};

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

<ClickHouseSupportedBadge />

[Amazon Glue](https://aws.amazon.com/glue/) は、Amazon Web Services (AWS) が提供する完全マネージド型のサーバーレス データインテグレーションサービスです。分析、機械学習、アプリケーション開発に向けて、データの検出、準備、変換を簡素化します。

<div id="installation">
  ## インストール
</div>

Glue コードを ClickHouse と統合するには、次のいずれかの方法で Glue から公式の Spark コネクタを使用できます。

* AWS Marketplace から ClickHouse Glue コネクタをインストールする (推奨) 。
* Spark Connector の JAR を Glue ジョブに手動で追加する。

<Tabs>
  <Tab title="AWS Marketplace">
    <Steps titleSize="h3">
      <Step title="コネクタをサブスクライブする" id="subscribe-to-the-connector">
        アカウントでコネクタを利用するには、AWS Marketplace で ClickHouse AWS Glue Connector をサブスクライブします。
      </Step>

      <Step title="必要な権限を付与する" id="grant-required-permissions">
        最小権限の[ガイド](https://docs.aws.amazon.com/glue/latest/dg/getting-started-min-privs-job.html#getting-started-min-privs-connectors)に記載されているとおり、Glue ジョブの IAM ロールに必要な権限があることを確認してください。
      </Step>

      <Step title="コネクタを有効化して接続を作成する" id="activate-the-connector">
        サブスクライブ後、ジョブの要件に合った Glue バージョンを選択します。**Additional details** セクションの **Usage instructions** で、**Open Glue Studio - Add ClickHouse connector** へのリンクをクリックします。すると、主要なフィールドが事前入力された Glue の接続作成ページが開きます。接続に名前を付けて、作成をクリックしてください (この段階では ClickHouse の接続情報を指定する必要はありません) 。

        <Image img="https://mintcdn.com/private-7c7dfe99-trino-dialect/zkBy8QRjLpx6BosZ/images/integrations/data-ingestion/aws-glue/marketplace-usage-instructions.png?fit=max&auto=format&n=zkBy8QRjLpx6BosZ&q=85&s=d7eb0a5c56bb6478043408c7f043abaf" size="md" alt="ClickHouse Glue コネクタ向け AWS Marketplace の使用手順" width="1024" height="182" data-path="images/integrations/data-ingestion/aws-glue/marketplace-usage-instructions.png" />
      </Step>

      <Step title="Glue ジョブで使用する" id="use-in-glue-job">
        Glue ジョブで `Job details` タブを選択し、`Advanced properties` ウィンドウを展開します。`Connections` セクションで、先ほど作成した接続を選択します。コネクタは必要な JAR をジョブランタイムに自動的に追加します。

        <Image img="https://mintcdn.com/private-7c7dfe99-trino-dialect/zkBy8QRjLpx6BosZ/images/integrations/data-ingestion/aws-glue/notebook-connections-config.webp?fit=max&auto=format&n=zkBy8QRjLpx6BosZ&q=85&s=37ac0c0187108958739175644e161f4a" size="md" alt="Glue Notebook の接続設定" force="true" width="877" height="742" data-path="images/integrations/data-ingestion/aws-glue/notebook-connections-config.webp" />

        <Note>
          Glue ジョブの設定に一致するコネクタバージョンを選択してください:

          * **Glue 4**: Spark 3.3, Scala 2, Python 3
          * **Glue 5**: Spark 3.5, Scala 2, Python 3
        </Note>
      </Step>
    </Steps>
  </Tab>

  <Tab title="手動インストール">
    必要な JAR を手動で追加するには、次の手順に従ってください。

    <Steps titleSize="h3">
      <Step title="コネクタ JAR をアップロードする">
        最新の Spark コネクタ JAR (`clickhouse-spark-runtime-3.X_2.X-0.10.X.jar`) を S3 バケットにアップロードします。
      </Step>

      <Step title="S3 バケットへのアクセスを付与する">
        Glue ジョブがこのバケットにアクセスできることを確認します。
      </Step>

      <Step title="依存 JAR パスを設定する">
        `Job details` タブで下にスクロールし、`Advanced properties` のドロップダウンを展開して、`Dependent JARs path` に JAR のパスを入力します。

        <Image img="https://mintcdn.com/private-7c7dfe99-trino-dialect/zkBy8QRjLpx6BosZ/images/integrations/data-ingestion/aws-glue/dependent_jars_path_option.webp?fit=max&auto=format&n=zkBy8QRjLpx6BosZ&q=85&s=b9e7143669a8e5d7ffa10ea0e105307c" size="md" alt="Glue Notebook の JAR パスオプション" force="true" width="954" height="753" data-path="images/integrations/data-ingestion/aws-glue/dependent_jars_path_option.webp" />
      </Step>
    </Steps>
  </Tab>
</Tabs>

<div id="secrets-manager">
  ## 認証情報に AWS Secrets Manager を使用する
</div>

ClickHouse のユーザー名とパスワードをジョブ内にハードコードする代わりに、[AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/) に保存し、Glue の接続またはジョブスクリプトからそのシークレットを参照します。実行時には、Glue がシークレットを取得し、そのキー・バリューのペアをコネクタの接続オプションにマージします。

<div id="create-secret">
  ### シークレットを作成する
</div>

AWS Secrets Manager で、キーがコネクタのオプション名と一致するキー・バリューのペアを含む **その他のシークレットタイプ** のシークレットを作成します。

| Key        | Value             |
| ---------- | ----------------- |
| `user`     | ClickHouse のユーザー名 |
| `password` | ClickHouse のパスワード |

シークレットに追加したキーはすべてコネクタに転送されるため、コードに含めたくない場合は、`host`、`database`、そのほかのオプションもここに保存できます。

<div id="reference-secret">
  ### シークレットを参照する
</div>

シークレットをジョブで利用する方法は 2 つあります。

**方法 1: Glue 接続にアタッチする。** Glue Studio で ClickHouse connection を作成または編集する際に、**AWS secret** フィールドへシークレット名を設定します。この接続を使用するジョブではシークレットが自動的に解決されるため、コードを変更する必要はありません。

**方法 2: connection options で `secretId` を渡す。** シークレットが接続にアタッチされていない場合は、この方法を使用します。`connectionName` とあわせて `secretId` を追加します。

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    source = glueContext.create_dynamic_frame.from_options(
        connection_type="marketplace.spark",
        connection_options={
            "connectionName": "<your-connection-name>",
            "secretId": "clickhouse/glue/credentials",
            "database": "default",
            "table": "example_table"
        },
        transformation_ctx="clickhouse_source"
    )
    ```
  </Tab>

  <Tab title="Scala">
    ```scala theme={null}
    val source = glueContext.getSource(
      connectionType = "marketplace.spark",
      connectionOptions = JsonOptions(Map(
        "connectionName" -> "<your-connection-name>",
        "secretId" -> "clickhouse/glue/credentials",
        "database" -> "default",
        "table" -> "example_table"
      )),
      transformationContext = "clickhouseSource"
    )
    ```
  </Tab>
</Tabs>

シークレット内の `user` キーと `password` キーは実行時にコネクタのオプションへマージされるため、スクリプト内でそれらを読み取る必要はありません。

<div id="example">
  ## 例
</div>

以下の例では `marketplace.spark` を使用し、`connectionName` でコネクタを参照します。コネクタを手動でインストールした場合 (手動インストール タブ) は、代わりに `connection_type="custom.spark"` を使用し、`className`、`host`、`http_port`、`user`、`password` を options に直接指定してください。

接続自体に AWS シークレットをアタッチしている場合 ([Using AWS Secrets Manager for credentials](#secrets-manager) の Option 1) は、options から `secretId` を削除してください。Glue は接続から認証情報を自動的に取得します。

<Tabs>
  <Tab title="Visual Editor">
    Glue Studio の visual editor では、ClickHouse コネクタをソースとしてもターゲットとしても使用できます。ClickHouse Spark Connector コンポーネントをキャンバスにドラッグし、データパイプラインに接続するだけです。

    <Image img="https://mintcdn.com/private-7c7dfe99-trino-dialect/zkBy8QRjLpx6BosZ/images/integrations/data-ingestion/aws-glue/glue-studio-visual-editor.png?fit=max&auto=format&n=zkBy8QRjLpx6BosZ&q=85&s=7cd32932dec2893a03442470e201b034" size="md" alt="ClickHouse connector を使用した Glue Studio visual editor" width="1024" height="645" data-path="images/integrations/data-ingestion/aws-glue/glue-studio-visual-editor.png" />
  </Tab>

  <Tab title="Scala">
    ```java theme={null}
    import com.amazonaws.services.glue.GlueContext
    import com.amazonaws.services.glue.util.{GlueArgParser, Job, JsonOptions}
    import org.apache.spark.SparkContext
    import scala.collection.JavaConverters._

    object ClickHouseGlueExample {
      def main(sysArgs: Array[String]): Unit = {
        val args = GlueArgParser.getResolvedOptions(sysArgs, Seq("JOB_NAME").toArray)

        val sc = new SparkContext()
        val glueContext = new GlueContext(sc)
        Job.init(args("JOB_NAME"), glueContext, args.asJava)

        val readOptions = JsonOptions(Map(
          "connectionName" -> "<your-connection-name>",
          "secretId" -> "clickhouse/glue/credentials",
          "database" -> "default",
          "table" -> "example_table"
        ))

        val source = glueContext.getSource(
          connectionType = "marketplace.spark",
          connectionOptions = readOptions,
          transformationContext = "clickhouseSource"
        )
        val dyf = source.getDynamicFrame()

        val writeOptions = JsonOptions(Map(
          "connectionName" -> "<your-connection-name>",
          "secretId" -> "clickhouse/glue/credentials",
          "database" -> "default",
          "table" -> "target_table"
        ))

        glueContext.getSink(
          connectionType = "marketplace.spark",
          connectionOptions = writeOptions
        ).writeDynamicFrame(dyf)

        Job.commit()
      }
    }
    ```
  </Tab>

  <Tab title="Python">
    ```python theme={null}
    import sys
    from awsglue.utils import getResolvedOptions
    from pyspark.context import SparkContext
    from awsglue.context import GlueContext
    from awsglue.job import Job

    args = getResolvedOptions(sys.argv, ['JOB_NAME'])

    sc = SparkContext()
    glueContext = GlueContext(sc)
    logger = glueContext.get_logger()
    job = Job(glueContext)
    job.init(args['JOB_NAME'], args)

    read_options = {
        "connectionName": "<your-connection-name>",
        "secretId": "clickhouse/glue/credentials",
        "database": "default",
        "table": "example_table"
    }

    source = glueContext.create_dynamic_frame.from_options(
        connection_type="marketplace.spark",
        connection_options=read_options,
        transformation_ctx="clickhouse_source"
    )
    dyf = source

    logger.info(f"Read {dyf.count()} rows from ClickHouse")

    write_options = {
        "connectionName": "<your-connection-name>",
        "secretId": "clickhouse/glue/credentials",
        "database": "default",
        "table": "target_table"
    }

    glueContext.write_dynamic_frame.from_options(
        frame=dyf,
        connection_type="marketplace.spark",
        connection_options=write_options,
        transformation_ctx="clickhouse_sink"
    )

    job.commit()
    ```
  </Tab>
</Tabs>

詳細については、[Spark ドキュメント](/ja/integrations/connectors/data-ingestion/apache-spark) を参照してください。