Использование Visual Studio Code для подключения и запроса экземпляров Azure Cosmos DB

Область применения: Nosql MongoDB

Visual Studio Code — это универсальный редактор кода для Linux, macOS и Windows, поддерживающий множество расширений. В этом кратком руководстве показано, как подключиться к кластеру Azure Cosmos DB для NoSQL и Azure Cosmos DB для MongoDB (vCore) с помощью Visual Studio Code. В ней рассматриваются основные операции базы данных, включая запросы, вставку, обновление и удаление данных.

Необходимые компоненты

Перед началом работы убедитесь, что имеется следующее:

• Учетная запись Azure Cosmos DB, настроенная с базой данных и коллекцией для API NoSQL. Чтобы настроить ресурс, воспользуйтесь любым из следующих кратких руководств:

  • Портал
  • Azure CLI

• Чтобы подключить данные в Azure Cosmos DB и управлять ими в Visual Studio, сначала установите расширение "Базы данных Azure".

  1. Откройте Visual Studio Code.
  2. Перейдите к области расширений, выбрав "Просмотреть > расширения" или нажав клавиши CTRL+SHIFT+X в Windows и COMMAND+ SHIFT+ X в MacOS.
  3. В строке поиска введите расширение "Базы данных Azure" и выберите расширение. Затем нажмите кнопку "Установить".
  4. После установки перезагрузите Visual Studio Code при появлении запроса.

Подключение к Azure Cosmos DB для NoSQL

1. В Visual Studio Code перейдите в область Azure (щелкните значок Azure на панели действий).
2. Войдите в учетную запись Azure с помощью идентификатора Записи. Примечание. Рекомендуется всегда использовать идентификатор Microsoft Entra ID RBAC при доступе к ресурсам Azure Cosmos DB (вместо ключей учетных записей) для наиболее безопасного метода проверки подлинности.
3. После входа в представление дерева Azure найдите подписку Azure и выполните детализацию до Azure Cosmos DB.
4. Выберите существующую учетную запись или щелкните правой кнопкой мыши, чтобы создать новый ресурс.

Запрос и отображение данных

Следующие действия будут использовать Редактор запросов для выполнения запроса и просмотра результатов запроса:

1. В меню коллекции щелкните правой кнопкой мыши коллекцию, чтобы открыть Редактор запросов в предварительной версии.

   

2. Запустите запрос, предоставленный в редакторе запросов, чтобы отобразить данные в представлении таблицы:

   

3. Изучите данные в других поддерживаемых представлениях:

• Представление JSON: см. структуру необработанных данных.
• Представление дерева: легко изучить вложенные данные.

Просмотр метрик запросов и индексов

В редакторе запросов просмотрите дополнительные метрики запросов и индексов, чтобы лучше оптимизировать производительность запроса.

1. Перейдите на вкладку "Статистика" рядом с результатами запроса.

2. Дополнительные сведения об определениях метрик см. в документации по метрикам запросов.

Вставка, изменение и удаление документов

• Редактирование документа в режиме реального времени: добавление, просмотр, изменение и удаление документов мгновенно с изменениями, отраженными в режиме реального времени.
• Импорт из JSON: быстрая загрузка данных из JSON-файлов.

Экспорт результатов запроса

• Скачать результаты: скачать результаты запроса в CSV-файлы или JSON.

Следующие шаги

В этом руководстве вы узнали, как запрашивать данные в VS Code, экспортировать результаты запроса, просматривать метрики запросов и индексов для настройки производительности запросов и отображения данных в нескольких поддерживаемых представлениях. Теперь вы можете использовать расширение VS Code баз данных Azure для просмотра реальных данных в базе данных.

• Начало работы с API для NoSQL
• Краткое руководство по Node.js
• Краткое руководство по Python
• Краткое руководство для Java
• Краткое руководство по переходу

Необходимые компоненты

Перед началом работы убедитесь, что имеется следующее:

• Учетная запись Azure Cosmos DB, настроенная с базой данных в Azure Cosmos DB для MongoDB. Используйте одно из следующих кратких руководств для настройки базы данных:
  • Портал
  • Azure CLI
• Чтобы подключить данные в Azure Cosmos DB и управлять ими, необходимо установить расширение баз данных Azure для Visual Studio Code.
  1. Откройте Visual Studio Code.
  2. Перейдите к области расширений, выбрав "Просмотреть > расширения" или нажав клавиши CTRL+SHIFT+X в Windows и COMMAND+ SHIFT+ X в MacOS.
  3. В строке поиска введите расширение "Базы данных Azure" и выберите расширение. Затем нажмите кнопку "Установить".
  4. После установки перезагрузите Visual Studio Code при появлении запроса.
• Оболочка MongoDB (mongosh), установленная для взаимодействия командной строки (необязательно, но рекомендуется).

---

Подключение к рабочей нагрузке MongoDB

Подключение к кластеру Azure Cosmos DB для MongoDB (vCore)

1. В расширении "Базы данных Azure" разверните раздел "Ресурсы Azure".
2. Найдите подписку , у вас есть рабочая нагрузка MongoDB. В соответствии с требуемой подпиской вы заметите ветвь Azure Cosmos DB для MongoDB (vCore). Разверните ветвь для просмотра кластеров и баз данных.
3. Выберите кластер Azure Cosmos DB для MongoDB (vCore) из развернутого списка.
4. При появлении запроса введите пароль администратора для кластера.
5. После проверки подлинности вы получите доступ к кластеру.

Примечание.

Пароль используется только для проверки подлинности и не хранится.

Примечание.

Во многих корпоративных средах IP-адреса компьютера разработчика скрыты из-за VPN или других параметров корпоративной сети. В этих случаях рекомендуется начать с разрешения доступа ко всем IP-адресам , добавив правило брандмауэра 0.0.0 –255.255.255.255.255, прежде чем уточнить список разрешений.

Подключение к любому кластеру MongoDB

1. На панели рабочей области разверните раздел учетных записей MongoDB.
2. Здесь можно просмотреть все учетные записи MongoDB. Чтобы подключиться к новой учетной записи MongoDB с помощью строка подключения, нажмите кнопку "Создать подключение" и введите строка подключения при появлении запроса.
   • При необходимости вам может потребоваться указать имя пользователя и пароль для проверки подлинности.

Примечание.

Все успешно подключенные кластеры MongoDB останутся в разделе учетных записей MongoDB, даже после закрытия VS Code.

Интуитивно понятные Управление данными

Легко управлять базами данных в Visual Studio Code:

• Создание и удаление баз данных или коллекций: щелкните правой кнопкой мыши учетную запись, базу данных или коллекцию на панели ресурсов, чтобы создать или удалить базы данных и коллекции.

• Импорт из JSON: быстро импортируйте данные из JSON-файлов в коллекцию.

  • Инициирование импорта
    1. Щелкните правой кнопкой мыши имя коллекции в представлении ресурсов и выберите "Импортировать документы в коллекцию".
    2. Кроме того, откройте представление коллекции, щелкнув запись "Документы " коллекции, а затем нажмите кнопку "Импорт ".
  • Выбор JSON-файла
    1. Найдите файл *.json, содержащий данные.
    2. Подтвердите запуск процесса импорта.

• Экспорт данных: сохранение коллекций или результатов запроса в формате JSON для резервного копирования или общего доступа.

  • Инициирование экспорта:
    • Вариант 1
      1. Щелкните правой кнопкой мыши имя коллекции в представлении ресурсов и выберите "Экспорт документов из коллекции ", чтобы экспортировать всю коллекцию.
    • Вариант 2
      1. Откройте представление коллекции, щелкнув запись "Документы " коллекции, а затем нажмите кнопку "Экспорт ".
      2. Выберите экспорт всей коллекции или результатов текущего запроса.
  • Укажите целевой файл:
    1. Введите имя и расположение для целевого файла *.json.
    2. Подтвердите экспорт, чтобы начать сохранение данных.

• Редактирование документа в режиме реального времени: мгновенное добавление, просмотр, изменение и удаление документов с обновлениями в режиме реального времени.

  • Открытие редактирования документа:
    • Доступ к параметрам редактирования документов непосредственно в представлении коллекции. Эти элементы управления удобно расположены над представлением данных для простого доступа.
  • Доступные действия:
    • Добавление: создание новых документов в коллекции.
    • Представление. Просмотр содержимого выбранного документа.
    • Изменение: изменение содержимого выбранных документов.
    • Удаление. Удалите выбранные документы с изменениями, отраженными немедленно.

Мощные средства запросов

Простое выполнение и уточнение запросов:

• Мгновенные результаты: немедленно просматривать результаты запроса в предпочитаемом формате— табличном представлении, JSON или дереве.

  • Легко переключать представления с помощью раскрывающегося меню "Вид ".

• Выполнение запросов напрямую: запись и выполнение запросов MongoDB с такими функциями, как выделение синтаксиса и автозавершение.

  • Чтобы выполнить запрос, нажмите кнопку "Найти запрос" или нажмите в Ctrl/Cmd+Enter редакторе запросов.

Примечание.

В настоящее время поддерживаются только запросы фильтров с расширенными возможностями запросов.

Гибкие представления данных

Изучите данные с помощью нескольких представлений для разных перспектив:

• Представление JSON: см. необработанную структуру данных JSON.

• Представление дерева: навигация и изучение вложенных данных без усилий.

• Представление таблицы. Быстрое сканирование данных и детализация в вложенных документах.

  • Для детализации: поиск записей со значком {} , указывающим внедренные объекты. Дважды щелкните, чтобы развернуть и просмотреть содержимое.
  • Чтобы вернуться обратно: используйте панели навигации под представлением таблицы, чтобы вернуться к предыдущим уровням.

Интеграция Оболочки Mongo

Доступны функции командной строки:

• Запуск mongosh: выполнение расширенных команд MongoDB непосредственно из Visual Studio Code.

Примечание.

Оболочка MongoDB (mongosh) не входит в расширение. Его необходимо установить отдельно и настроить вручную.

Управление кластерами

Оставайтесь на вершине ваших ресурсов:

• Просмотр сведений о кластере. Проверьте уровень кластера, версию сервера и использование ресурсов.

• Управление тегами. Упорядочение кластеров с тегами, которые синхронизируются с порталом Azure.

Следующие шаги

Перенос рабочей нагрузки MongoDB в Azure Cosmos DB