接続ガイド

接続 URI の一部

次の図は、サンプル接続 URI の各部分について説明しています。

この例では、プロトコルに mongodbを使用し、標準接続文字列形式を指定します。配置の柔軟性を高め、クライアントを再構成せずにサーバーをローテーションで変更する機能が必要な場合は、DNS シード リスト接続形式を使用することもできます。

接続stringの次の部分には、データベースユーザー名と、パスワードベースの認証を使用している場合はパスワードが含まれます。 userの値をデータベースユーザー名に、 passの値をパスワードに置き換えます。 ユーザー名とパスワードを必要としない認証メカニズムを使用している場合は、接続 URI のこの部分を省略します。

接続文字列の次の部分は、MongoDB インスタンスのホスト名または IP アドレスとポートを指定します。前の例では、ホスト名としてsample.hostを使用し、ポートとして27017を使用しています。これらの値を置き換えて、MongoDB インスタンスを指すようにします。

接続stringの最後の部分は、接続オプションと認証オプションを指定します。 この例では、 maxPoolSize=20とw=majorityの 2 つの接続オプションを設定しています。 接続オプションの詳細については、このガイドの「接続オプション 」セクションをお読みください。

接続例

MongoDB に接続するには、クライアントを作成する必要があります。クライアントが接続を管理し、データベースコマンドを実行します。

ClientOptions オブジェクトを Connect() メソッドに渡すことで、接続文字列とその他のクライアント オプションを使用するクライアントを作成できます。

接続 URI を指定するには、それを ApplyURI() メソッドに渡します。これにより、新しい ClientOptions インスタンスが返されます。その他のオプションを設定するには、 optionsパッケージから関連するヘルパー メソッドを呼び出します。

接続オプションの詳細については、 「接続オプション」セクションを参照してください。クライアントの作成の詳細については、 クライアント および Connect()のAPIドキュメントを参照してください。

新しいサーバー バージョンにアップグレードするときに重大な変更を回避するために、Stable API バージョンをオプションとして設定できます。Stable API 機能について詳しくは、「Stable API」ページをご覧ください。

次のコードは、Atlas接続文字列と Stable API バージョンを使用するクライアントを作成し、MongoDB に接続して、接続が成功したことを確認する方法を示しています。

// Connects to MongoDB and sets a Stable API version
package main
import (
	"context"
	"fmt"
	"go.mongodb.org/mongo-driver/bson"
	"go.mongodb.org/mongo-driver/mongo"
	"go.mongodb.org/mongo-driver/mongo/options"
)
// Replace the placeholder with your Atlas connection string
const uri = "<connection string>"
func main() {
	// Use the SetServerAPIOptions() method to set the Stable API version to 1
	serverAPI := options.ServerAPI(options.ServerAPIVersion1)
	opts := options.Client().ApplyURI(uri).SetServerAPIOptions(serverAPI)
	// Create a new client and connect to the server
	client, err := mongo.Connect(context.TODO(), opts)
	if err != nil {
		panic(err)
	}
	defer func() {
		if err = client.Disconnect(context.TODO()); err != nil {
			panic(err)
		}
	}()
	// Send a ping to confirm a successful connection
	var result bson.M
	if err := client.Database("admin").RunCommand(context.TODO(), bson.D{{"ping", 1}}).Decode(&result); err != nil {
		panic(err)
	}
	fmt.Println("Pinged your deployment. You successfully connected to MongoDB!")
}

ローカルマシン上の MongoDB Server への接続

開発目的でローカルマシン上で MongoDB サーバーを実行する必要がある場合は、次の手順を実行します。

1. MongoDB Server の Communityバージョン または Enterprise バージョンをダウンロードします。

2. MongoDB Serverをインストールして構成します。

3. サーバーを起動します。

MongoDB Serverを正常に開始したら、ドライバー接続コードで接続文字列を指定します。

MongoDB Server がローカルで実行されている場合は、接続文字列 "mongodb://localhost:<port>" を使用できます。ここで、<port> は、着信接続をリッスンするようにサーバーに設定したポート番号です。

別のホスト名または IP アドレスを指定する場合は、サーバー マニュアルの「接続文字列 」に関する記述を参照してください。

サーバーに接続できるかどうかをテストするには、前のコード例の接続文字列を localhost 接続文字列に置き換えます。

レプリカセットへの接続

MongoDB レプリカセットの配置は、同じデータ セットを保存する接続されたインスタンスのグループです。この構成により、データの冗長性と高いデータ可用性が実現します。

レプリカセットの配置に接続するには、各インスタンスのホスト名とポート番号をカンマで区切って指定し、レプリカセット名を接続文字列の replicaSet パラメーターの値として指定します。次の例では、ホスト名は host1、 host2、 host3で、ポート番号はすべて27017です。レプリカセット名は myRSです。

mongodb://host1:27017,host2:27017,host3:27017/?replicaSet=myRS

レプリカセットに接続すると、ドライバーはデフォルトで次のアクションを実行します。

• いずれかのノードのアドレスが指定されると、レプリカセットのすべてのノードを検出します。

• プライマリに対する書込み指示などの操作を適切なノードに割り振ります。

Single Timeout Setting

Clientに単独の Timeout オプションを設定して、SetTimeout() メソッドを使用するか、接続 URI 文字列で timeoutMS オプションを指定して、1 回の操作の実行にかかる時間を制御できます。同じエンティティに対する操作のコンテキストを設定しない場合、コード内の他の場所にある Database、 Collection、 Session、 ChangeStream、および Bucket インスタンスは、Client から Timeout オプションを継承します。

期限が設定されたオペレーションに Context を渡すと、ドライバーでの操作にはその Context の期限が使用されます。Context に期限がない場合、ドライバは Client に設定された Timeout オプションを使用して、指定された Context から新しいContext を生成します。

次のコードは、 SetTimeoutオプションを使用してClientにTimeoutオプションを設定する方法を示しています。

opts := options.Client().SetTimeout(5 * time.Second)

次の例では、URI オプションで1つのタイムアウトを設定し、この設定を継承する操作を実行する方法を示します。

uri := "mongodb://user:pass@sample.host:27017/?timeoutMS=5000"
client := mongo.Connect(context.TODO(), uri)
coll := client.Database("<db>").Collection("<collection>")
...
coll.InsertOne(context.Background(), doc)