快速入门:使用 Node.js SDK 和 Azure Cosmos DB 构建 Cassandra 应用

适用于: Cassandra API

在本快速入门中,你将创建一个 Azure Cosmos DB Cassandra API 帐户,并使用从 GitHub 克隆的 Cassandra Node.js 应用创建一个 Cassandra 数据库和一个容器。 Azure Cosmos DB 是一种多模型数据库服务,可让你通过多区域分布和水平缩放功能快速创建和查询文档、表、键/值和图数据库。

先决条件

如果没有 Azure 试用版订阅,请在开始前创建一个试用版订阅

此外,还需要:

创建数据库帐户

在创建文档数据库之前,需通过 Azure Cosmos DB 创建 Cassandra 帐户。

  1. 在 Azure 门户菜单或主页中,选择“创建资源” 。

  2. 在“新建”页面中搜索“Azure Cosmos DB”,然后选择它。

  3. 在“Azure Cosmos DB”页上,选择“创建”。

  4. 在“创建 Azure Cosmos DB 帐户”页中,输入新 Azure Cosmos 帐户的基本设置。

    设置 Value 说明
    订阅 你的订阅 选择要用于此 Azure Cosmos DB 帐户的 Azure 订阅。
    资源组 新建

    然后,输入与帐户名称相同的名称。
    选择“新建”。 然后输入帐户的新资源组名称。 为简单起见,请使用与 Azure Cosmos 帐户名称相同的名称。
    帐户名 输入唯一的名称 输入标识此 Azure Cosmos DB 帐户的唯一名称。 帐户 URI 将是追加到唯一帐户名称的“cassandra.cosmos.azure.cn” 。

    帐户名称只能使用小写字母、数字及连字符 (-),必须为 3 到 31 个字符长。
    API Cassandra API 确定要创建的帐户的类型。 Azure Cosmos DB 提供五种 API:Core(SQL)(适用于文档数据库)、Gremlin(适用于图数据库)、MongoDB(适用于文档数据库)、Azure 表和 Cassandra。 必须为每种 API 创建单独的帐户。

    选择“Cassandra” ,因为本快速入门将创建使用 Cassandra API 的表。

    详细了解 Cassandra API
    位置 离用户最近的区域 选择用于托管 Azure Cosmos DB 帐户的地理位置。 使用离用户最近的位置,使他们能够以最快的速度访问数据。
    容量模式 预配吞吐量或无服务器 选择“预配吞吐量”以在预配吞吐量模式下创建帐户。 选择“无服务器”以在无服务器模式下创建帐户。
    应用免费层折扣 “应用”或“不应用” 使用 Azure Cosmos DB 免费层,你将在帐户中获得每秒前 1000 RU 的免费吞吐量和 25 GB 的免费存储。 了解免费层的详细信息。

    备注

    每个 Azure 订阅最多可以有一个免费层 Azure Cosmos DB 帐户,并且你必须在创建帐户时选择加入使用。 如果看不到用于应用免费层折扣的选项,这意味着订阅中的另一个帐户已启用免费层。

    Azure Cosmos DB Cassandra API 的“新建帐户”页面

  5. 在“全局分发”选项卡中,配置以下详细信息。 对于本快速入门,可以保留默认值:

    设置 Value 说明
    异地冗余 禁用 通过将你的区域与某个配对区域进行配对来启用或禁用帐户的多区域分发。 稍后可以将更多区域添加到帐户。
    多区域写入 禁用 借助多区域写入功能,可以利用全中国的数据库和容器的预配吞吐量。

    备注

    如果选择“无服务器”作为“容量模式”,则以下选项不可用 :

    • 应用免费层折扣
    • 异地冗余
    • 多区域写入
  6. (可选)可以在以下选项卡中配置其他详细信息:

    • 网络 - 配置 来自虚拟网络的访问

    • 备份策略 - 配置 定期备份策略。

    • 加密 - 使用服务管理的密钥或 客户管理的密钥

    • 标记 - 标记是名称/值对,通过将相同的标记应用到多个资源和资源组,可以对资源进行分类并查看合并的账单。

  7. 选择“查看 + 创建”。

  8. 检查帐户设置,然后选择“创建”。 创建帐户需要几分钟时间。 等待门户页显示“你的部署已完成”消息。

    Azure 门户“通知”窗格

  9. 选择“转到资源”,转到 Azure Cosmos DB 帐户页。

克隆示例应用程序

现在从 GitHub 克隆 Cassandra API 应用,设置连接字符串,并运行应用。 会看到以编程方式处理数据是多么容易。

  1. 打开命令提示符。 创建名为 git-samples 的新文件夹。 然后,关闭命令提示符。

    md "C:\git-samples"
    
  2. 打开 git 终端窗口(例如 git bash)。 使用 cd 命令更改为要安装示例应用的新文件夹。

    cd "C:\git-samples"
    
  3. 运行下列命令,克隆示例存储库。 此命令在计算机上创建示例应用程序的副本。

    git clone https://github.com/Azure-Samples/azure-cosmos-db-cassandra-nodejs-getting-started.git
    
  4. 使用 npm 安装 Node.js 依赖项。

    npm install
    

查看代码

此步骤是可选的。 如果有意了解如何通过代码创建数据库资源,可以查看以下代码片段。 这些代码片段全部摘自 C:\git-samples\azure-cosmos-db-cassandra-nodejs-getting-started 文件夹中 uprofile.js 文件。 否则,可以直接跳转到更新连接字符串

  • 用户名和密码值是使用 Azure 门户中的连接字符串页设置的。

      let authProvider = new cassandra.auth.PlainTextAuthProvider(
          config.username,
          config.password
      );
    
  • 使用 contactPoint 信息初始化 client。 从 Azure 门户中检索 contactPoint。

    let client = new cassandra.Client({
        contactPoints: [`${config.contactPoint}:10350`],
        authProvider: authProvider,
        localDataCenter: config.localDataCenter,
        sslOptions: {
            secureProtocol: "TLSv1_2_method"
        },
    });
    
  • client 连接到 Azure Cosmos DB Cassandra API。

    client.connect();
    
  • 创建新的键空间。

    var query =
        `CREATE KEYSPACE IF NOT EXISTS ${config.keySpace} WITH replication = {'class': 'NetworkTopologyStrategy', 'datacenter' : '1' }`;
    await client.execute(query);
    }
    
  • 创建新表。

      query =
          `CREATE TABLE IF NOT EXISTS ${config.keySpace}.user (user_id int PRIMARY KEY, user_name text, user_bcity text)`;
      await client.execute(query);
    },
    
  • 插入键/值实体。

    const arr = [
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (1, 'AdrianaS', 'Seattle')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (2, 'JiriK', 'Toronto')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (3, 'IvanH', 'Mumbai')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (4, 'IvanH', 'Seattle')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (5, 'IvanaV', 'Belgaum')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (6, 'LiliyaB', 'Seattle')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (7, 'JindrichH', 'Buenos Aires')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (8, 'AdrianaS', 'Seattle')`,
        `INSERT INTO  ${config.keySpace}.user (user_id, user_name , user_bcity) VALUES (9, 'JozefM', 'Seattle')`,
    ];
    for (const element of arr) {
        await client.execute(element);
    }
    
  • 用于获取所有键值的查询。

    query = `SELECT * FROM ${config.keySpace}.user`;
    const resultSelect = await client.execute(query);
    
    for (const row of resultSelect.rows) {
        console.log(
            "Obtained row: %d | %s | %s ",
            row.user_id,
            row.user_name,
            row.user_bcity
        );
    }
    
  • 用于获取键-值的查询。

    query = `SELECT * FROM ${config.keySpace}.user where user_id=1`;
    const resultSelectWhere = await client.execute(query);
    
    for (const row of resultSelectWhere.rows) {
        console.log(
            "Obtained row: %d | %s | %s ",
            row.user_id,
            row.user_name,
            row.user_bcity
        );
    }
    
  • 关闭连接。

    client.shutdown();
    

更新连接字符串

现在返回到 Azure 门户,获取连接字符串信息,并将其复制到应用。 连接字符串使应用能与托管数据库进行通信。

  1. Azure 门户的 Azure Cosmos DB 帐户中,选择“连接字符串”。

  2. 使用屏幕右侧的 按钮复制最上面的值“联系点”。

    在 Azure 门户的连接字符串页中查看并复制“联系点”、“用户名”和“密码”

  3. 打开 config.js 文件。

  4. 粘贴门户中的 CONTACT POINT 值,并覆盖第 9 行中的 'CONTACT-POINT

    第 9 行现在应类似于

    contactPoint: "cosmos-db-quickstarts.cassandra.cosmos.azure.cn",

  5. 复制并粘贴门户中的“用户名”值,并覆盖第 2 行中的 <FillMEIN>

    第 2 行现在应如下所示

    username: 'cosmos-db-quickstart',

  6. 复制并粘贴门户中的“密码”值,并覆盖第 8 行中的 USERNAME

    第 8 行现在应如下所示

    password: '2Ggkr662ifxz2Mg==',

  7. 将 REGION 替换为在其中创建此资源的 Azure 区域。

  8. 保存 config.js 文件。

运行 Node.js 应用

  1. 在终端窗口中,确保你位于此前克隆的示例目录中:

    cd azure-cosmos-db-cassandra-nodejs-getting-started
    
  2. 运行 Node 应用程序:

    npm start
    
  3. 通过命令行验证结果是否符合预期。

    查看并验证输出

    按 CTRL+C 停止执行程序并关闭控制台窗口。

  4. 在 Azure 门户中,打开数据资源管理器,以查询、修改和处理这些新数据。

    在数据资源管理器中查看数据

在 Azure 门户中查看 SLA

Azure 门户监视 Cosmos DB 帐户吞吐量、存储、可用性、延迟和一致性。 与 Azure Cosmos DB 服务级别协议 (SLA) 关联的指标的图表显示与实际性能相比的 SLA 值。 此套指标使得监视 SLA 十分透明。

若要查看指标和 SLA,请执行以下操作:

  1. 在 Cosmos DB 帐户的导航菜单中选择“指标”。

  2. 选择一个选项卡,如“延迟”,然后选择右侧的时间范围。 比较图表上的“实际”和“SLA”线。

    Azure Cosmos DB 指标套件

  3. 查看其他选项卡上的指标。

清理资源

执行完应用和 Azure Cosmos DB 帐户的操作以后,可以删除所创建的 Azure 资源,以免产生更多费用。 若要删除资源,请执行以下操作:

  1. 在 Azure 门户的“搜索”栏中,搜索并选择“资源组” 。

  2. 从列表中选择为本快速入门创建的资源组。

    选择要删除的资源组

  3. 在资源组“概览”页上,选择“删除资源组” 。

    删除资源组

  4. 在下一窗口中输入要删除的资源组的名称,然后选择“删除” 。

后续步骤

本快速入门介绍了如何使用 Cassandra API 创建 Azure Cosmos DB 帐户,以及如何运行用于创建 Cassandra 数据库和容器的 Cassandra Node.js 应用。 现在可以将其他数据导入 Azure Cosmos DB 帐户了。