文档首页
X DevAPI 用户指南
下载本手册
PDF (US Ltr) - 1.4Mb
PDF (A4) - 1.4Mb


X DevAPI 用户指南  /  连接和会话概念  /  数据库连接示例

2.1 数据库连接示例

连接到 MySQL 文档存储所需的代码与传统的 MySQL 连接代码非常相似,但现在应用程序可以建立到运行 X 插件的 MySQL 服务器实例的逻辑会话。会话由 mysqlx 工厂生成,返回的会话可以封装对运行 X 插件的一个或多个 MySQL 服务器实例的访问。默认情况下使用 Session 对象的应用程序可以部署在单服务器设置和数据库集群上,而无需更改代码。

使用 mysqlx.getSession(connection) 方法创建 X DevAPI 会话。您传入连接参数以连接到 MySQL 服务器,例如主机名和用户,这与其中一个经典 API 中的代码非常相似。连接参数可以指定为 URI 类型字符串,例如 user:@localhost:33060,也可以指定为数据字典,例如 {user: myuser, password: mypassword, host: example.com, port: 33060}。有关更多信息,请参阅 使用类似 URI 的字符串或键值对连接到服务器

用于连接的 MySQL 用户帐户应使用 mysql_native_passwordcaching_sha2_password 身份验证插件,请参阅 可插拔身份验证。您要连接到的服务器应启用加密连接,这是 MySQL 8.0 及更高版本中的默认设置。这可确保客户端使用 X 协议 PLAIN 密码机制,该机制适用于使用任一身份验证插件的用户帐户。如果您尝试连接到未启用加密连接的服务器实例,对于使用 mysql_native_password 插件的用户帐户,将首先尝试使用 MYSQL41 进行身份验证,而对于使用 caching_sha2_password 的用户帐户,身份验证将回退到 SHA256_MEMORY

以下示例代码显示了如何连接到 MySQL 服务器并从 my_collection 集合中获取字段 nameL 开头的文档。该示例假设存在一个名为 test 的模式,并且存在 my_collection 集合。要使示例正常工作,请将 user 替换为您的用户名,并将 password 替换为您的密码。如果您要连接到不同的主机或通过不同的端口连接,请将主机从 localhost 更改,将端口从 33060 更改。

MySQL Shell JavaScript 代码

var mysqlx = require('mysqlx');

// Connect to server on localhost
var mySession = mysqlx.getSession( {
                host: 'localhost', port: 33060,
                user: 'user', password: 'password' } );

var myDb = mySession.getSchema('test');

// Use the collection 'my_collection'
var myColl = myDb.getCollection('my_collection');

// Specify which document to find with Collection.find() and
// fetch it from the database with .execute()
var myDocs = myColl.find('name like :param').limit(1).
        bind('param', 'L%').execute();

// Print document
print(myDocs.fetchOne());

mySession.close();

MySQL Shell Python 代码

from mysqlsh import mysqlx

# Connect to server on localhost
mySession = mysqlx.get_session( {
        'host': 'localhost', 'port': 33060,
        'user': 'user', 'password': 'password' } )

myDb = mySession.get_schema('test')

# Use the collection 'my_collection'
myColl = myDb.get_collection('my_collection')

# Specify which document to find with Collection.find() and
# fetch it from the database with .execute()
myDocs = myColl.find('name like :param').limit(1).bind('param', 'L%').execute()

# Print document
document = myDocs.fetch_one()
print(document)

mySession.close()

Node.js JavaScript 代码

var mysqlx = require('@mysql/xdevapi');

// Connect to server on localhost
mysqlx
  .getSession({
    user: 'user',
    password: 'password',
    host: 'localhost',
    port: '33060'
  })
  .then(function (session) {
    var db = session.getSchema('test');
    // Use the collection 'my_collection'
    var myColl = db.getCollection('my_collection');
    // Specify which document to find with Collection.find() and
    // fetch it from the database with .execute()
    return myColl
      .find('name like :param')
      .limit(1)
      .bind('param', 'L%')
      .execute(function (doc) {
        console.log(doc);
      });
  })
  .catch(function (err) {
    // Handle error
  });

C# 代码

// Connect to server on localhost
var mySession = MySQLX.GetSession("server=localhost;port=33060;user=user;password=password;");

var myDb = mySession.GetSchema("test");

// Use the collection "my_collection"
var myColl = myDb.GetCollection("my_collection");

// Specify which document to find with Collection.Find() and
// fetch it from the database with .Execute()
var myDocs = myColl.Find("name like :param").Limit(1)
	.Bind("param", "L%").Execute();

// Print document
Console.WriteLine(myDocs.FetchOne());

mySession.Close();

Python 代码

import mysqlx

# Connect to server on localhost
my_session = mysqlx.get_session({
     'host': 'localhost', 'port': 33060,
     'user': 'user', 'password': 'password'
 })

my_schema = my_session.get_schema('test')

# Use the collection 'my_collection'
my_coll = my_schema.get_collection('my_collection')

# Specify which document to find with Collection.find() and
# fetch it from the database with .execute()
docs = my_coll.find('name like :param').limit(1).bind('param', 'L%').execute()

# Print document
doc = docs.fetch_one()
print(doc)

my_session.close()

Java 代码

import com.mysql.cj.xdevapi.*;

// Connect to server on localhost
Session mySession = new SessionFactory().getSession("mysqlx://127.0.0.1:33060/test?user=user&password=password");

Schema myDb = mySession.getSchema("test");

// Use the collection 'my_collection'
Collection myColl = myDb.getCollection("my_collection");

// Specify which document to find with Collection.find() and
// fetch it from the database with .execute()
DocResult myDocs = myColl.find("name like :param").limit(1).bind("param", "L%").execute();

// Print document
System.out.println(myDocs.fetchOne());

mySession.close();

C++ 代码

#include <mysqlx/xdevapi.h>

// Scope controls life-time of objects such as session or schema

{
  Session sess("localhost", 33060, "user", "password");
  Schema db= sess.getSchema("test");
  // or Schema db(sess, "test");

  Collection myColl = db.getCollection("my_collection");
  // or Collection myColl(db, "my_collection");

  DocResult myDocs = myColl.find("name like :param")
                           .limit(1)
                           .bind("param","L%").execute();

  cout << myDocs.fetchOne();
}