These generators back the default output = "r6" discovery interface.
Users normally receive objects from fabric_workspaces(), fabric_items(),
fabric_item(), the typed discovery helpers, or fabric_catalog_search()
rather than constructing them directly.
Format
An R6::R6Class generator.
Details
Every object includes the complete Fabric API record. Read non-conflicting
fields directly with $; use $get() for collision-safe field access and
$as_list() or as.list() for a plain record. $get() is an object-only
field helper. Record fields are read-only.
Methods delegate to the corresponding fabric_*() function. Their ...
arguments are forwarded unchanged, and the credential used for discovery is
reused while the object is in the current R process. An explicitly
supplied token, tenant_id, client_id, auth_args, or api_base takes
precedence. Job and refresh lifecycle methods prefer the supplied handle's
in-process credential over the discovery credential. Bare IDs and handles
whose credentials were removed by serialization use the discovery credential.
The Fabric API base used for discovery is also reused, so chained
methods stay on the same public, sovereign-cloud, or workspace endpoint.
SQL-capable resources inherit common sql_*() methods. Lakehouses,
Warehouses, mirrored databases, Eventhouses, KQL databases, GraphQL APIs,
semantic models, and runnable job items add workload-specific methods.
Other discovered types are returned as FabricItem objects with $details()
(fabric_item()) and record access. They do not expose methods that cannot
operate from discovery metadata. This generic fallback also applies to
typed Environment and User Data Function discovery; a typed helper and
workload detail route do not by themselves imply a specialized R6 class.
FabricEventhouse and FabricKqlDatabase share the KQL methods documented
below under their internal FabricKqlItem superclass: $query(), $tables(),
$read_table(), $ingest(), $write_table(), $export(),
$ingestion_status(), and $ingestion_wait().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()
FabricWorkspace$new()
Internal constructor used by discovery factories.
Usage
FabricWorkspace$new(
record,
legacy_class = c("fabric_workspace", "list"),
credential = NULL,
api_base = NULL
)FabricWorkspace$items()
Discover items in this workspace.
Arguments
...Arguments forwarded to
fabric_items().
FabricWorkspace$item()
Discover and enrich one item in this workspace.
Arguments
itemItem GUID, display name, or discovered item.
...Arguments forwarded to
fabric_item().
FabricWorkspace$user_data_functions()
![[Experimental]](figures/lifecycle-experimental.svg)
Discover User Data Functions in this workspace. The service-principal development sandbox can use Core discovery, but it cannot provision and fully inspect disposable User Data Function fixtures.
FabricWorkspace$shortcut_cache_reset()
Reset this workspace's OneLake shortcut cache.
Arguments
...Arguments forwarded to
fabric_onelake_shortcut_cache_reset().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()
FabricItem$new()
Internal constructor used by discovery factories.
Usage
FabricItem$new(
record,
legacy_class = c("fabric_item", "list"),
credential = NULL,
api_base = NULL
)FabricItem$details()
Retrieve a fresh item record and supported workload details.
User Data Function workload details require detail = TRUE and a
delegated user identity.
Arguments
...Arguments forwarded to
fabric_item().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()FabricSqlItem$sql_connect()FabricSqlItem$sql_connection_info()FabricSqlItem$sql_query()FabricSqlItem$sql_read_table()FabricSqlItem$sql_tables()FabricSqlItem$sql_views()
FabricLakehouse$schemas()
List Lakehouse schemas.
Arguments
...Arguments forwarded to
fabric_lakehouse_schemas().
FabricLakehouse$table()
Retrieve one Lakehouse table's metadata.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_lakehouse_table().
FabricLakehouse$tables()
List Lakehouse tables.
Arguments
...Arguments forwarded to
fabric_lakehouse_tables().
FabricLakehouse$read_table()
Read one managed Delta table.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_lakehouse_read_table().
FabricLakehouse$read_delta_table()
Read a Delta table directly from OneLake.
Arguments
table_pathTable path below the item.
...Arguments forwarded to
fabric_onelake_read_delta_table().
FabricLakehouse$load_table()
Load an existing file into a managed table.
Arguments
tableDestination table name.
pathSource path under the Lakehouse.
...Arguments forwarded to
fabric_lakehouse_load_table().
FabricLakehouse$write_table()
Write R or Arrow data to a managed table.
Arguments
tableDestination table name.
dataData frame or Arrow-compatible source.
...Arguments forwarded to
fabric_lakehouse_write_table().
FabricLakehouse$livy_query()
Run one Spark statement through Livy.
Arguments
codeSpark, PySpark, SparkR, or Spark SQL code.
...Arguments forwarded to
fabric_livy_query().
FabricLakehouse$livy_session()
Create a reusable Livy session.
Arguments
...Arguments forwarded to
fabric_livy_session().
FabricLakehouse$livy_batch_submit()
Submit a standalone Livy batch.
Arguments
fileABFSS application-file URI.
...Arguments forwarded to
fabric_livy_batch_submit().
Returns
A FabricLivyBatch or its result.
FabricLakehouse$onelake_list()
List OneLake files and directories.
Arguments
pathPath within the Lakehouse.
...Arguments forwarded to
fabric_onelake_list().
FabricLakehouse$onelake_metadata()
Retrieve OneLake path metadata.
Arguments
pathPath within the Lakehouse.
...Arguments forwarded to
fabric_onelake_metadata().
FabricLakehouse$onelake_read_file()
Read a supported file from OneLake.
Arguments
pathPath within the Lakehouse.
...Arguments forwarded to
fabric_onelake_read_file().
FabricLakehouse$onelake_write_file()
Write data to a supported OneLake file.
Arguments
pathDestination path within the Lakehouse.
dataData to write.
...Arguments forwarded to
fabric_onelake_write_file().
FabricLakehouse$onelake_download()
Download one OneLake file.
Arguments
pathSource path within the Lakehouse.
...Arguments forwarded to
fabric_onelake_download().
FabricLakehouse$onelake_upload()
Upload a local file or raw vector to OneLake.
Arguments
pathDestination path within the Lakehouse.
sourceLocal path or raw vector.
...Arguments forwarded to
fabric_onelake_upload().
FabricLakehouse$onelake_delete()
Delete a OneLake path.
Arguments
pathPath within the Lakehouse.
...Arguments forwarded to
fabric_onelake_delete().
FabricLakehouse$schema_exists()
Check whether a schema exists.
Arguments
schemaSchema name.
...Arguments forwarded to
fabric_onelake_schema_exists().
FabricLakehouse$table_exists()
Check whether a table exists.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_onelake_table_exists().
FabricLakehouse$shortcuts()
List OneLake shortcuts.
Arguments
...Arguments forwarded to
fabric_onelake_shortcuts().
FabricLakehouse$shortcut()
Retrieve one OneLake shortcut.
Arguments
pathShortcut parent path.
nameShortcut name.
...Arguments forwarded to
fabric_onelake_shortcut_get().
FabricLakehouse$shortcut_create()
Create a OneLake shortcut.
Arguments
pathShortcut parent path.
nameShortcut name.
targetShortcut target.
...Arguments forwarded to
fabric_onelake_shortcut_create().
FabricLakehouse$shortcuts_bulk_create()
Create multiple OneLake shortcuts.
Arguments
shortcutsShortcut request lists.
...Arguments forwarded to
fabric_onelake_shortcuts_bulk_create().
FabricLakehouse$shortcut_delete()
Delete one OneLake shortcut.
Arguments
pathShortcut parent path.
nameShortcut name.
...Arguments forwarded to
fabric_onelake_shortcut_delete().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()FabricSqlItem$sql_connect()FabricSqlItem$sql_connection_info()FabricSqlItem$sql_query()FabricSqlItem$sql_read_table()FabricSqlItem$sql_tables()FabricSqlItem$sql_views()
FabricWarehouse$schemas()
List Warehouse schemas.
Arguments
...Arguments forwarded to
fabric_warehouse_schemas().
FabricWarehouse$table()
Retrieve one Warehouse table's metadata.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_warehouse_table().
FabricWarehouse$tables()
List Warehouse tables.
Arguments
...Arguments forwarded to
fabric_warehouse_tables().
FabricWarehouse$read_table()
Read one Warehouse table.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_warehouse_read_table().
FabricWarehouse$write_table()
Write R or Arrow data to a Warehouse table.
Arguments
tableDestination table name.
dataData frame or Arrow-compatible source.
staging_lakehouseLakehouse used for staged Parquet data.
...Arguments forwarded to
fabric_warehouse_write_table().
FabricWarehouse$read_delta_table()
Read a Delta table directly from OneLake.
Arguments
table_pathTable path below the item.
...Arguments forwarded to
fabric_onelake_read_delta_table().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()FabricSqlItem$sql_connect()FabricSqlItem$sql_connection_info()FabricSqlItem$sql_query()FabricSqlItem$sql_read_table()FabricSqlItem$sql_tables()FabricSqlItem$sql_views()
FabricMirroredDatabase$schemas()
List mirrored database schemas.
Arguments
...Arguments forwarded to
fabric_mirrored_database_schemas().
FabricMirroredDatabase$table()
Retrieve one mirrored table's metadata.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_mirrored_database_table().
FabricMirroredDatabase$tables()
List mirrored database tables.
Arguments
...Arguments forwarded to
fabric_mirrored_database_tables().
FabricMirroredDatabase$read_table()
Read one mirrored Delta table.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_mirrored_database_read_table().
FabricMirroredDatabase$read_delta_table()
Read a Delta table directly from OneLake.
Arguments
table_pathTable path below the item.
...Arguments forwarded to
fabric_onelake_read_delta_table().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()
FabricKqlItem$query()
Run a KQL query.
Arguments
queryOne KQL query.
...Arguments forwarded to
fabric_kql_query().
Returns
A typed tibble, or a fabric_kql_tables list for multiple
primary results; see fabric_kql_query().
FabricKqlItem$read_table()
Read one KQL table.
Arguments
tableTable name or discovered table row.
...Arguments forwarded to
fabric_kql_read_table().
FabricKqlItem$ingest()
Ingest existing sources into a KQL table.
Arguments
tableDestination table name.
sourcesSource URLs or source records.
formatSource data format.
...Arguments forwarded to
fabric_kql_ingest().
FabricKqlItem$write_table()
Write R or Arrow data to a KQL table.
Arguments
tableDestination table name.
dataData frame or Arrow-compatible source.
...Arguments forwarded to
fabric_kql_write_table().
FabricKqlItem$export()
Export a KQL query to Fabric storage.
Arguments
queryOne KQL query.
destinationDestination Fabric item or OneLake target.
...Arguments forwarded to
fabric_kql_export().
FabricKqlItem$ingestion_status()
Retrieve one KQL ingestion status snapshot.
Arguments
ingestionIngestion handle, status record, or operation ID.
...Arguments forwarded to
fabric_kql_ingestion_status().
FabricKqlItem$ingestion_wait()
Wait for a KQL ingestion to finish.
Arguments
ingestionIngestion handle, status record, or operation ID.
...Arguments forwarded to
fabric_kql_ingestion_status().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()
FabricGraphQLApi$query()
Run a GraphQL query.
Arguments
queryOne GraphQL query.
...Arguments forwarded to
fabric_graphql_query().
FabricGraphQLApi$schema()
Retrieve the GraphQL schema.
Arguments
...Arguments forwarded to
fabric_graphql_schema().
FabricGraphQLApi$paginate()
Retrieve all pages of a GraphQL cursor query.
Arguments
queryOne GraphQL query.
next_cursorFunction extracting the next cursor.
...Arguments forwarded to
fabric_graphql_paginate().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()
FabricSemanticModel$dax_query()
Run a DAX query against this semantic model.
Arguments
daxOne DAX query.
...Arguments forwarded to
fabric_pbi_dax_query().
FabricSemanticModel$refresh()
Start a refresh of this semantic model.
Arguments
...Arguments forwarded to
fabric_pbi_refresh().
FabricSemanticModel$refresh_history()
Retrieve this semantic model's refresh history.
Arguments
...Arguments forwarded to
fabric_pbi_refresh_history().
FabricSemanticModel$refresh_status()
Retrieve one refresh status snapshot.
Arguments
refreshRefresh handle, detail record, or request ID.
...Arguments forwarded to
fabric_pbi_refresh_status().
FabricSemanticModel$refresh_wait()
Wait for a submitted refresh to finish.
Arguments
refreshRefresh handle or detail record.
...Arguments forwarded to
fabric_pbi_refresh_wait().
FabricSemanticModel$refresh_cancel()
Cancel a submitted refresh.
Arguments
refreshRefresh handle, detail record, or request ID.
...Arguments forwarded to
fabric_pbi_refresh_cancel().
Methods
Inherited methods
FabricRecord$as_list()FabricRecord$field_names()FabricRecord$get()FabricRecord$print()FabricItem$details()FabricItem$initialize()
FabricJobItem$run()
Start an on-demand item job.
Arguments
...Arguments forwarded to
fabric_job_run().
FabricJobItem$status()
Retrieve one job status snapshot.
Arguments
jobJob handle, instance record, or job instance ID.
...Arguments forwarded to
fabric_job_status().
FabricJobItem$wait()
Wait for a submitted job to finish.
Arguments
jobJob handle or instance record.
...Arguments forwarded to
fabric_job_wait().
FabricJobItem$cancel()
Cancel a submitted job.
Arguments
jobJob handle, instance record, or job instance ID.
...Arguments forwarded to
fabric_job_cancel().
FabricJobItem$instances()
Retrieve this item's job history.
Arguments
...Arguments forwarded to
fabric_job_instances().
FabricJobItem$schedules()
List this item's schedules.
Arguments
...Arguments forwarded to
fabric_job_schedules().
FabricJobItem$schedule_create()
Create an item schedule.
Arguments
configurationA
fabric_job_schedule_config()record....Arguments forwarded to
fabric_job_schedule_create().
FabricJobItem$schedule_update()
Update an item schedule.
Arguments
schedule_idSchedule GUID or schedule record.
configurationOptional replacement schedule configuration.
...Arguments forwarded to
fabric_job_schedule_update().
FabricJobItem$schedule_delete()
Delete an item schedule.
Arguments
schedule_idSchedule GUID or schedule record.
...Arguments forwarded to
fabric_job_schedule_delete().
Examples
if (FALSE) { # \dontrun{
workspace <- fabric_workspaces()[[1L]]
workspace$displayName
# Equivalent function: fabric_lakehouses(workspace)
lakehouse <- workspace$lakehouses()[[1L]]
lakehouse$id
# Equivalent function: fabric_lakehouse_tables(lakehouse)
lakehouse$tables()
# Equivalent function: fabric_lakehouse_read_table(lakehouse, ...)
orders <- lakehouse$read_table("orders", limit = 100L)
# Workload-specific subclasses expose their own lifecycle methods
# Equivalent function: fabric_semantic_models(workspace)
model <- workspace$semantic_models()[[1L]]
# Equivalent function: fabric_pbi_refresh(model)
refresh <- model$refresh()
# Equivalent function: fabric_pbi_refresh_wait(refresh, ...)
model$refresh_wait(refresh, timeout = 1800)
# Equivalent generic: as.list(lakehouse)
lakehouse_record <- lakehouse$as_list()
# Fabric item types outside the typed-helper subset remain usable records
report <- workspace$items(type = "Report")[[1L]]
report$type
} # }