NotebookUtils (бывший MSSparkUtils) для Fabric

Утилиты для записных книжек (NotebookUtils) — это встроенный пакет, который помогает легко выполнять распространенные задачи в среде Fabric Notebook. NotebookUtils можно использовать для работы с файловыми системами, получения переменных среды, объединения блокнотов и работы с секретными данными. Пакет NotebookUtils доступен в ноутбуках PySpark (Python), Scala, SparkR и конвейерах Fabric.

Note

  • MsSparkUtils официально переименована в NotebookUtils. Существующий код остается обратной совместимости и не вызывает разрывных изменений. Настоятельно рекомендуется обновить notebookutils, чтобы обеспечить постоянную поддержку и доступ к новым функциям. Пространство имен mssparkutils будет выведено из эксплуатации в будущем.
  • NotebookUtils предназначен для работы с Spark 3.4 (Runtime версии 1.2) и выше. Все новые функции и обновления теперь и в будущем будут поддерживаться исключительно в пространстве имен notebookutils.

Модули NotebookUtils

NotebookUtils предоставляет следующие модули. Выберите модуль, чтобы просмотреть подробную документацию, примеры кода и рекомендации.

Модуль Namespace Описание
Служебные программы файловой системы notebookutils.fs Работа с файлами и каталогами в хранилище ADLS Gen2, Azure Blob Storage и Lakehouse. Включает операции копирования, перемещения, чтения, записи, удаления и списка.
Монтирование и размонтирование файлов notebookutils.fs Подключите удаленное хранилище (ADLS 2-го поколения) к узлам Spark в качестве локальных точек подключения для упрощенного доступа к файлам.
Запуск ноутбука и управление notebookutils.notebook Запуск и объединение записных книжек, включая параллельное выполнение с поддержкой DAG, ссылки на межпространственные рабочие области и выходные значения.
Управление записной книжкой notebookutils.notebook Программное создание, получение, обновление, удаление и перечисление артефактов записной книжки.
Утилиты учетных данных notebookutils.credentials Получение маркеров доступа для служб Azure и получение секретов из Azure Key Vault.
Служебные программы Lakehouse notebookutils.lakehouse Создание, получение, обновление, удаление и управление элементами Lakehouse и таблицами программными средствами.
Контекст среды выполнения notebookutils.runtime Доступ к сведениям о контексте сеанса, включая имя записной книжки, сведения о рабочей области и контекст выполнения.
Управление сеансами notebookutils.session Остановите интерактивные сеансы и перезапустите интерпретатор Python.
Служебные программы функции пользовательских данных (UDF) notebookutils.udf Извлекает и вызывает функции пользовательских данных из записных книжек.
Служебные программы библиотеки переменных notebookutils.variableLibrary Доступ к централизованно управляемым переменным и конфигурации из элементов библиотеки переменных.

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

notebookutils.help()

Чтобы получить справку по конкретному модулю, выполните следующую команду:

notebookutils.fs.help()
notebookutils.notebook.help()
notebookutils.credentials.help()

Известные проблемы

  • При использовании версии среды выполнения выше 1.2 и запуска notebookutils.help()перечисленные API FabricClient и PBIClient пока не поддерживаются, но они будут доступны в будущем выпуске.