NotebookUtils variable biblioteksværktøjer til Fabric

Variable biblioteker hjælper dig med at undgå hardkodning af værdier i notesbogskode. I stedet for at redigere koden opdaterer du værdierne i biblioteket og henter dem under kørsel. Dette mønster hjælper dig med at genbruge notesbøger på tværs af teams og projekter ved at centralisere konfigurationen.

Følgende tabel viser de tilgængelige variable biblioteksmetoder:

Definér variable

Definér variablerne i dit variabelbibliotek, før du bruger notebookutils.variableLibrary. Du kan oprette og administrere variabelbiblioteker via Fabric UI.

Hent variabelbibliotek

Brug getLibrary() den til at hente hele biblioteket som et objekt, og derefter tilgå variabler som egenskaber. Brug getVariable('name') eller klammesyntaks library['name'] , når du har brug for dynamisk adgang.

samplevl = notebookutils.variableLibrary.getLibrary("sampleVL")

# Property access
samplevl.test_int
samplevl.test_str

# Method access (useful for dynamic variable names)
samplevl.getVariable("test_int")

# Bracket access
samplevl["test_int"]

val samplevl = notebookutils.variableLibrary.getLibrary("sampleVL")

samplevl.test_int
samplevl.test_str

samplevl <- notebookutils.variableLibrary.getLibrary("sampleVL")

samplevl$test_int()
samplevl$test_str()

Følgende eksempel viser, hvordan man dynamisk konstruerer en filsti ved hjælp af variable biblioteksværdier:

samplevl = notebookutils.variableLibrary.getLibrary("sampleVL")

file_path = f"abfss://{samplevl.Workspace_name}@onelake.dfs.fabric.microsoft.com/{samplevl.Lakehouse_name}.Lakehouse/Files/<FileName>.csv"
df = spark.read.format("csv").option("header","true").load(file_path)

display(df)

Få adgang til en enkelt variabel efter reference

Brug get() metoden med referencemønsteret $(/**/libraryName/variableName) til at hente en enkelt variabelværdi. Værdien indtastes automatisk baseret på variabeldefinitionen.

notebookutils.variableLibrary.get("$(/**/samplevl/test_int)")
notebookutils.variableLibrary.get("$(/**/samplevl/test_str)")
notebookutils.variableLibrary.get("$(/**/samplevl/test_bool)")

notebookutils.variableLibrary.get("$(/**/samplevl/test_int)")
notebookutils.variableLibrary.get("$(/**/samplevl/test_str)")
notebookutils.variableLibrary.get("$(/**/samplevl/test_bool)")

notebookutils.variableLibrary.get("$(/**/samplevl/test_int)")
notebookutils.variableLibrary.get("$(/**/samplevl/test_str)")
notebookutils.variableLibrary.get("$(/**/samplevl/test_bool)")

Understøttede variabeltyper

Variable biblioteker understøtter følgende datatyper. Værdier bliver automatisk indtastet, når du henter dem – du behøver i de fleste tilfælde ikke kaste dem eksplicit.

Miljøspecifik konfiguration

Variabelbiblioteker understøtter værdisæt, som lader dig definere alternative sæt af værdier for de samme variable—for eksempel dev, test og prod. Hvert arbejdsområde har ét aktivt værdisæt ad gangen, og deploymentspipelines kan automatisk aktivere den relevante værdi pr. fase.

Dette mønster eliminerer behovet for kodeændringer, når du promoverer notebooks på tværs af miljøer:

# These values change based on the active value set (dev/test/prod)
app_config = notebookutils.variableLibrary.getLibrary("app_config")

api_endpoint = app_config.api_endpoint
batch_size = app_config.batch_size
debug_mode = app_config.debug_enabled

print(f"API Endpoint: {api_endpoint}")
print(f"Batch Size: {batch_size}")
print(f"Debug Mode: {debug_mode}")

if debug_mode:
    print("Running in debug mode")

val appConfig = notebookutils.variableLibrary.getLibrary("app_config")

val apiEndpoint = appConfig.api_endpoint
val batchSize = appConfig.batch_size
val debugMode = appConfig.debug_enabled

println(s"API Endpoint: ${apiEndpoint}")
println(s"Batch Size: ${batchSize}")
println(s"Debug Mode: ${debugMode}")

if (debugMode) {
    println("Running in debug mode")
}

app_config <- notebookutils.variableLibrary.getLibrary("app_config")

api_endpoint <- app_config$api_endpoint()
batch_size <- app_config$batch_size()
debug_mode <- app_config$debug_enabled()

print(paste("API Endpoint:", api_endpoint))
print(paste("Batch Size:", batch_size))
print(paste("Debug Mode:", debug_mode))

if (debug_mode) {
    print("Running in debug mode")
}

Overvejelser

Hav disse overvejelser i tankerne:

• API'et notebookutils.variableLibrary understøtter kun adgang til variabelbiblioteker inden for samme arbejdsområde. Adgang på tværs af arbejdsområder understøttes ikke.
• Du kan ikke hente variabelbiblioteker på tværs af arbejdsområder i underordnede notesbøger under en referencekørsel.
• Notesbogskode refererer til de variabler, der er defineret i det aktive værdisæt i variabelbiblioteket. For at bruge forskellige værdier skal du aktivere et andet værdisæt i arbejdsområdet eller bruge deployment-pipelines til at administrere værdisæt for hvert miljø.
• Service Principal (SPN) understøttes i øjeblikket ikke for variable biblioteksværktøjer.
• Variable biblioteker er skrivebeskyttede fra notesbøger. Foretag ændringer via Fabric UI eller API'er.
• Hvert bibliotek understøtter op til 1.000 variable og 1.000 værdisæt, med maksimalt 10.000 celler og en størrelsesgrænse på 1 MB.
• Variabel- og biblioteksnavne er små og små bogstaver. Brug præcis navnematchning, når du refererer til variabler.

Relateret indhold

• NotebookUtils til stof