@dbx-tools/databricks 0.9.131 → 0.9.136
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -16
- package/index.ts +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +2 -2
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
# @dbx-tools/databricks
|
|
2
2
|
|
|
3
|
-
Databricks workspace,
|
|
3
|
+
Resolve Databricks workspace identity, access workspace files, detect cloud and
|
|
4
|
+
region, resolve DNS, and discover the caller's public IP.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
and region lookup, DNS resolution, and public IP discovery.
|
|
7
|
-
|
|
8
|
-
## Quick Start
|
|
6
|
+
## Quick start
|
|
9
7
|
|
|
10
8
|
Read and write a Unity Catalog volume through the shared filesystem API:
|
|
11
9
|
|
|
@@ -16,7 +14,7 @@ const files = new DatabricksFileSystem({ root: "main.default.assets" });
|
|
|
16
14
|
await files.writeFile("reports/latest.txt", "ready");
|
|
17
15
|
```
|
|
18
16
|
|
|
19
|
-
|
|
17
|
+
The package:
|
|
20
18
|
|
|
21
19
|
- Workspace URL and numeric workspace id resolution from AppKit context,
|
|
22
20
|
Databricks SDK config, env, and config files.
|
|
@@ -31,23 +29,28 @@ Key features:
|
|
|
31
29
|
- DNS A/AAAA lookup helpers for Databricks and adjacent service hosts.
|
|
32
30
|
- Memoized outbound public-IP discovery for setup and diagnostics.
|
|
33
31
|
|
|
34
|
-
##
|
|
32
|
+
## Choose application or agent file access
|
|
35
33
|
|
|
36
34
|
Use native AppKit for its standard workspace client and plugin integrations.
|
|
37
35
|
Use this package when code needs Databricks filesystem root normalization,
|
|
38
36
|
cloud region discovery, network helpers, or workspace identity fallbacks
|
|
39
37
|
outside an AppKit request.
|
|
40
38
|
|
|
41
|
-
|
|
39
|
+
Use AppKit's Files plugin when application routes or UI components need file and
|
|
40
|
+
volume operations. Use `DatabricksFileSystem` for backend libraries and for a
|
|
41
|
+
portable filesystem mounted into a Mastra agent workspace. Use
|
|
42
|
+
[@dbx-tools/fs](../fs) for host-local files.
|
|
43
|
+
|
|
44
|
+
## Filesystem targets
|
|
42
45
|
|
|
43
46
|
```ts
|
|
44
47
|
import { DatabricksFileSystem } from "@dbx-tools/databricks";
|
|
45
48
|
|
|
46
|
-
// Unity Catalog volume
|
|
49
|
+
// Unity Catalog volume using a three-part id
|
|
47
50
|
const volume = new DatabricksFileSystem({ root: "main.default.assets" });
|
|
48
51
|
await volume.writeFile("notes/hello.txt", "hi");
|
|
49
52
|
|
|
50
|
-
// Workspace home (resolves ~
|
|
53
|
+
// Workspace home (resolves ~ using currentUser.me / AppKit userName)
|
|
51
54
|
const home = await DatabricksFileSystem.create({ root: "~" });
|
|
52
55
|
const entries = await home.readdir(".");
|
|
53
56
|
```
|
|
@@ -63,15 +66,15 @@ Roots are normalized before use:
|
|
|
63
66
|
| `/dbfs/...` | unchanged (POSIX) | DBFS |
|
|
64
67
|
|
|
65
68
|
`~` expansion uses `getCurrentUserName()` (AppKit context `userName`, else
|
|
66
|
-
`currentUser.me()`
|
|
69
|
+
`currentUser.me()` through `tryGetWorkspaceClient` / `getWorkspaceClient`). Prefer
|
|
67
70
|
`DatabricksFileSystem.create({ root: "~" })` when the username is not known up
|
|
68
71
|
front.
|
|
69
72
|
|
|
70
|
-
Built on
|
|
73
|
+
Built on [@dbx-tools/shared-fs](../../shared/fs) `BaseFileSystem`, so portable behavior (parents,
|
|
71
74
|
recursion, encoding, error mapping) is shared with `LocalFileSystem` /
|
|
72
75
|
`MemoryFileSystem`.
|
|
73
76
|
|
|
74
|
-
## Resolve
|
|
77
|
+
## Resolve workspace identity
|
|
75
78
|
|
|
76
79
|
```ts
|
|
77
80
|
import { workspaceClient } from "@dbx-tools/databricks";
|
|
@@ -85,7 +88,7 @@ present, then a default Databricks SDK client, then environment/config. Use it i
|
|
|
85
88
|
libraries that should work inside an AppKit request and from a standalone
|
|
86
89
|
script.
|
|
87
90
|
|
|
88
|
-
## Detect
|
|
91
|
+
## Detect cloud provider and region
|
|
89
92
|
|
|
90
93
|
```ts
|
|
91
94
|
import { cloud } from "@dbx-tools/databricks";
|
|
@@ -101,7 +104,7 @@ or routing workspace-adjacent traffic.
|
|
|
101
104
|
Cloud detection is best-effort. It is intended for endpoint construction and
|
|
102
105
|
developer diagnostics, not for security policy decisions.
|
|
103
106
|
|
|
104
|
-
## Resolve
|
|
107
|
+
## Resolve network details
|
|
105
108
|
|
|
106
109
|
```ts
|
|
107
110
|
import { net } from "@dbx-tools/databricks";
|
|
@@ -122,4 +125,4 @@ short-lived reuse.
|
|
|
122
125
|
- `net` - DNS A/AAAA resolution and outbound public-IP discovery.
|
|
123
126
|
|
|
124
127
|
Zerobus endpoint construction builds on these helpers in
|
|
125
|
-
[
|
|
128
|
+
[@dbx-tools/databricks-zerobus](../databricks-zerobus).
|
package/index.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
|
|
5
5
|
export const PACKAGE_IDENTIFIER = "@dbx-tools/databricks";
|
|
6
|
-
export const PACKAGE_VERSION = "0.9.
|
|
6
|
+
export const PACKAGE_VERSION = "0.9.136";
|
|
7
7
|
export * as cloud from "./src/cloud.ts";
|
|
8
8
|
export * as databricksFS from "./src/databricks-fs.ts";
|
|
9
9
|
export * as databricksPath from "./src/databricks-path.ts";
|
package/lib/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export declare const PACKAGE_IDENTIFIER = "@dbx-tools/databricks";
|
|
2
|
-
export declare const PACKAGE_VERSION = "0.9.
|
|
2
|
+
export declare const PACKAGE_VERSION = "0.9.136";
|
|
3
3
|
export * as cloud from "./src/cloud.ts";
|
|
4
4
|
export * as databricksFS from "./src/databricks-fs.ts";
|
|
5
5
|
export * as databricksPath from "./src/databricks-path.ts";
|
package/lib/index.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// Regenerated from the exporting modules in ./src.
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
export const PACKAGE_IDENTIFIER = "@dbx-tools/databricks";
|
|
5
|
-
export const PACKAGE_VERSION = "0.9.
|
|
5
|
+
export const PACKAGE_VERSION = "0.9.136";
|
|
6
6
|
export * as cloud from "./src/cloud.js";
|
|
7
7
|
export * as databricksFS from "./src/databricks-fs.js";
|
|
8
8
|
export * as databricksPath from "./src/databricks-path.js";
|
|
@@ -12,4 +12,4 @@ export { RANGE_CACHE_TTL_MS, CloudProvider } from "./src/cloud.js";
|
|
|
12
12
|
export { DatabricksFileSystem } from "./src/databricks-fs.js";
|
|
13
13
|
export { isHomeRelativePath } from "./src/databricks-path.js";
|
|
14
14
|
export { getPublicIp } from "./src/net.js";
|
|
15
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
15
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyx1QkFBdUIsQ0FBQztBQUMxRCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxLQUFLLE1BQU0sZ0JBQWdCLENBQUM7QUFDeEMsT0FBTyxLQUFLLFlBQVksTUFBTSx3QkFBd0IsQ0FBQztBQUN2RCxPQUFPLEtBQUssY0FBYyxNQUFNLDBCQUEwQixDQUFDO0FBQzNELE9BQU8sS0FBSyxHQUFHLE1BQU0sY0FBYyxDQUFDO0FBQ3BDLE9BQU8sS0FBSyxlQUFlLE1BQU0sMkJBQTJCLENBQUM7QUFDN0QsT0FBTyxFQUFFLGtCQUFrQixFQUFFLGFBQWEsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRW5FLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRTlELE9BQU8sRUFBRSxrQkFBa0IsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBRTlELE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxjQUFjLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBHRU5FUkFURUQgYnkgcHJvamVuIHdhdGNoIC0gRE8gTk9UIEVESVQuXG4vLyBSZWdlbmVyYXRlZCBmcm9tIHRoZSBleHBvcnRpbmcgbW9kdWxlcyBpbiAuL3NyYy5cbi8vIEhhbmQgZWRpdHMgYXJlIG92ZXJ3cml0dGVuIG9uIHRoZSBuZXh0IHdhdGNoOyB0aGlzIGZpbGUgaXMgcmVhZC1vbmx5LlxuXG5leHBvcnQgY29uc3QgUEFDS0FHRV9JREVOVElGSUVSID0gXCJAZGJ4LXRvb2xzL2RhdGFicmlja3NcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS4xMzZcIjtcbmV4cG9ydCAqIGFzIGNsb3VkIGZyb20gXCIuL3NyYy9jbG91ZC50c1wiO1xuZXhwb3J0ICogYXMgZGF0YWJyaWNrc0ZTIGZyb20gXCIuL3NyYy9kYXRhYnJpY2tzLWZzLnRzXCI7XG5leHBvcnQgKiBhcyBkYXRhYnJpY2tzUGF0aCBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy1wYXRoLnRzXCI7XG5leHBvcnQgKiBhcyBuZXQgZnJvbSBcIi4vc3JjL25ldC50c1wiO1xuZXhwb3J0ICogYXMgd29ya3NwYWNlQ2xpZW50IGZyb20gXCIuL3NyYy93b3Jrc3BhY2UtY2xpZW50LnRzXCI7XG5leHBvcnQgeyBSQU5HRV9DQUNIRV9UVExfTVMsIENsb3VkUHJvdmlkZXIgfSBmcm9tIFwiLi9zcmMvY2xvdWQudHNcIjtcbmV4cG9ydCB0eXBlIHsgQ2xvdWRMb2NhdGlvbiB9IGZyb20gXCIuL3NyYy9jbG91ZC50c1wiO1xuZXhwb3J0IHsgRGF0YWJyaWNrc0ZpbGVTeXN0ZW0gfSBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy1mcy50c1wiO1xuZXhwb3J0IHR5cGUgeyBEYXRhYnJpY2tzRmlsZVN5c3RlbUNsaWVudFJlc29sdmVyLCBEYXRhYnJpY2tzRmlsZVN5c3RlbU9wdGlvbnMsIERhdGFicmlja3NTdHJlYW1Xcml0ZU9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy1mcy50c1wiO1xuZXhwb3J0IHsgaXNIb21lUmVsYXRpdmVQYXRoIH0gZnJvbSBcIi4vc3JjL2RhdGFicmlja3MtcGF0aC50c1wiO1xuZXhwb3J0IHR5cGUgeyBEYXRhYnJpY2tzRmlsZXNCYWNrZW5kLCBOb3JtYWxpemVEYXRhYnJpY2tzUm9vdE9wdGlvbnMsIFJlc29sdmVEYXRhYnJpY2tzUm9vdE9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy1wYXRoLnRzXCI7XG5leHBvcnQgeyBnZXRQdWJsaWNJcCB9IGZyb20gXCIuL3NyYy9uZXQudHNcIjtcbmV4cG9ydCB0eXBlIHsgV29ya3NwYWNlQ2xpZW50IH0gZnJvbSBcIi4vc3JjL3dvcmtzcGFjZS1jbGllbnQudHNcIjtcbiJdfQ==
|
package/package.json
CHANGED
|
@@ -24,12 +24,12 @@
|
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@databricks/appkit": "0.81.0",
|
|
27
|
-
"@dbx-tools/appkit": "^0.9.
|
|
28
|
-
"@dbx-tools/auth": "^0.9.
|
|
29
|
-
"@dbx-tools/cli-service": "^0.9.
|
|
30
|
-
"@dbx-tools/core": "^0.9.
|
|
31
|
-
"@dbx-tools/shared-core": "^0.9.
|
|
32
|
-
"@dbx-tools/shared-fs": "^0.9.
|
|
27
|
+
"@dbx-tools/appkit": "^0.9.136",
|
|
28
|
+
"@dbx-tools/auth": "^0.9.136",
|
|
29
|
+
"@dbx-tools/cli-service": "^0.9.136",
|
|
30
|
+
"@dbx-tools/core": "^0.9.136",
|
|
31
|
+
"@dbx-tools/shared-core": "^0.9.136",
|
|
32
|
+
"@dbx-tools/shared-fs": "^0.9.136"
|
|
33
33
|
},
|
|
34
34
|
"main": "./lib/index.js",
|
|
35
35
|
"license": "Apache-2.0",
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
"./package.json": "./package.json"
|
|
70
70
|
}
|
|
71
71
|
},
|
|
72
|
-
"version": "0.9.
|
|
72
|
+
"version": "0.9.136",
|
|
73
73
|
"types": "./lib/index.d.ts",
|
|
74
74
|
"dbxToolsConfig": {
|
|
75
75
|
"tags": [
|