Spark Connector のスタートガイド

依存関係マネジメント

Spark Core、Spark SQL、MongoDB Spark Connector の依存関係を依存関係管理ツールに指定します。

次の例は、これらの依存関係を Maven pom.xmlファイルに含める方法を示しています。

<dependencies>
  <dependency>
    <groupId>org.mongodb.spark</groupId>
    <artifactId>mongo-spark-connector_2.13</artifactId>
    <version>11.1.0</version>
  </dependency>
  <dependency>
    <groupId>org.apache.spark</groupId>
    <artifactId>spark-core_2.13</artifactId>
    <version>4.0.0</version>
  </dependency>
  <dependency>
    <groupId>org.apache.spark</groupId>
    <artifactId>spark-sql_2.13</artifactId>
    <version>4.0.0</version>
  </dependency>
</dependencies>

構成

SparkSession経由で Connector 構成を指定する場合、 設定の前に適切に設定する必要があります。 詳細とその他の使用可能な MongoDB Spark Connector オプションについては、「 Spark の構成」ガイドを参照してください。

package com.mongodb.spark_examples;
import org.apache.spark.sql.SparkSession;
public final class GettingStarted {
  public static void main(final String[] args) throws InterruptedException {
    /* Create the SparkSession.
     * If config arguments are passed from the command line using --conf,
     * parse args for the values to set.
     */
    SparkSession spark = SparkSession.builder()
      .master("local")
      .appName("MongoSparkConnectorIntro")
      .config("spark.mongodb.read.connection.uri", "mongodb://127.0.0.1/test.myCollection")
      .config("spark.mongodb.write.connection.uri", "mongodb://127.0.0.1/test.myCollection")
      .getOrCreate();
    // Application logic
  }
}

• spark.mongodb.read.connection.uriでは、MongoDB サーバーのアドレス（ 127.0.0.1 ）、接続するデータベース（ test ）、データを読み取るコレクション（ myCollection ）と読み込み設定（read preference）を指定します。

• spark.mongodb.write.connection.uriは、MongoDB サーバーアドレス（ 127.0.0.1 ）、接続するデータベース（ test ）、データを書き込むコレクション（ myCollection ）を指定します。

SparkSessionオブジェクトを使用して、MongoDB へのデータの書き込み、MongoDB からのデータの読み取り、データセットの作成、SQL 操作の実行を行えます。

Python Spark shell

このチュートリアルではpyspark shell を使用しますが、このコードは自己完結型の Python アプリケーションでも動作します。

pyspark shell を起動するときに、以下を指定できます。

• MongoDB Spark Connector パッケージをダウンロードするには、 --packagesオプションを使用します。 次のパッケージが利用できます。

  • mongo-spark-connector

• MongoDB Spark Connector を構成するには、 --confオプションを使用します。 これらの設定はSparkConfオブジェクトを構成します。

  注意

  SparkConf を使用してSpark Connectorを構成する場合は、 の前に適切に設定する必要があります。 詳細とその他の使用可能な MongoDB Spark Connector オプションについては、「 Spark の構成」ガイドを参照してください。

次の例では、コマンドラインからpyspark shell を起動します。

./bin/pyspark --conf "spark.mongodb.read.connection.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
              --conf "spark.mongodb.write.connection.uri=mongodb://127.0.0.1/test.myCollection" \
              --packages org.mongodb.spark:mongo-spark-connector_2.12:11.1.0

• spark.mongodb.read.connection.uriでは、MongoDB サーバーのアドレス（ 127.0.0.1 ）、接続するデータベース（ test ）、データを読み取るコレクション（ myCollection ）と読み込み設定（read preference）を指定します。

• spark.mongodb.write.connection.uriは、MongoDB サーバーアドレス（ 127.0.0.1 ）、接続するデータベース（ test ）、データを書き込むコレクション（ myCollection ）を指定します。 デフォルトでポート27017に接続します。

• packagesオプションは、Spark Connector の Maven 座標をgroupId:artifactId:version形式で指定します。

このチュートリアルの例では、このデータベースとコレクションを使用します。

SparkSession オブジェクトの作成

pysparkの起動時にspark.mongodb.read.connection.uriとspark.mongodb.write.connection.uri構成オプションを指定した場合、デフォルトのSparkSessionオブジェクトはそれらを使用します。 pyspark内から独自のSparkSessionオブジェクトを作成する場合は、 SparkSession.builderを使用して別の構成オプションを指定できます。

from pyspark.sql import SparkSession
my_spark = SparkSession \
    .builder \
    .appName("myApp") \
    .config("spark.mongodb.read.connection.uri", "mongodb://127.0.0.1/test.coll") \
    .config("spark.mongodb.write.connection.uri", "mongodb://127.0.0.1/test.coll") \
    .getOrCreate()

SparkSessionオブジェクトを使用して、MongoDB へのデータの書き込み、MongoDB からのデータの読み取り、DataFrames の作成、SQL 操作の実行を行えます。

Spark shell

Spark shell を起動するときに、以下を指定します。

• MongoDB Spark Connector パッケージをダウンロードするには、 --packagesオプションを使用します。 次のパッケージが利用できます。

  • mongo-spark-connector

• MongoDB Spark Connector を構成するには、 --confオプションを使用します。 これらの設定はSparkConfオブジェクトを構成します。

  注意

  SparkConf を使用してSpark Connectorを構成する場合は、 の前に適切に設定する必要があります。 詳細とその他の使用可能な MongoDB Spark Connector オプションについては、「 Spark の構成」ガイドを参照してください。

たとえば、

./bin/spark-shell --conf "spark.mongodb.read.connection.uri=mongodb://127.0.0.1/test.myCollection?readPreference=primaryPreferred" \
                  --conf "spark.mongodb.write.connection.uri=mongodb://127.0.0.1/test.myCollection" \
                  --packages org.mongodb.spark:mongo-spark-connector_2.12:11.1.0

• spark.mongodb.read.connection.uriでは、MongoDB サーバーのアドレス（ 127.0.0.1 ）、接続するデータベース（ test ）、データを読み取るコレクション（ myCollection ）と読み込み設定（read preference）を指定します。

• spark.mongodb.write.connection.uriは、MongoDB サーバーアドレス（ 127.0.0.1 ）、接続するデータベース（ test ）、データを書き込むコレクション（ myCollection ）を指定します。 デフォルトでポート27017に接続します。

• packagesオプションは、Spark Connector の Maven 座標をgroupId:artifactId:version形式で指定します。

import com.mongodb.spark._

自己完結型の Scala アプリケーション

scalaVersion := "2.13",
libraryDependencies ++= Seq(
  "org.mongodb.spark" %% "mongo-spark-connector_2.13" % "11.1.0",
  "org.apache.spark" %% "spark-core" % "4.0.0",
  "org.apache.spark" %% "spark-sql" % "4.0.0"
)

package com.mongodb
object GettingStarted {
  def main(args: Array[String]): Unit = {
    /* Create the SparkSession.
     * If config arguments are passed from the command line using --conf,
     * parse args for the values to set.
     */
    import org.apache.spark.sql.SparkSession
    val spark = SparkSession.builder()
      .master("local")
      .appName("MongoSparkConnectorIntro")
      .config("spark.mongodb.read.connection.uri", "mongodb://127.0.0.1/test.myCollection")
      .config("spark.mongodb.write.connection.uri", "mongodb://127.0.0.1/test.myCollection")
      .getOrCreate()
  }
}

トラブルシューティング

java.net.BindException: Can't assign requested addressを取得した場合、

• 別の Spark shell がすでに実行されていないことを確認してください。

• SPARK_LOCAL_IP環境変数を設定してみてください。例:

  export SPARK_LOCAL_IP=127.0.0.1

• Spark shell を起動するときに、次のオプションを含めてみてください。

  --driver-java-options "-Djava.net.preferIPv4Stack=true"

このチュートリアルの例の実行中にエラーが発生した場合は、ローカル Ividy キャッシュ（ ~/.ivy2/cache/org.mongodb.sparkと~/.ivy2/jars ）をクリアする必要がある場合があります。