-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCLI Reference.html
740 lines (558 loc) · 33.4 KB
/
CLI Reference.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<link rel="stylesheet" href="/assets/css/just-the-docs-default.css">
<style type="text/css">
.site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.external):nth-child(3) > .nav-list-link { display: block; font-weight: 600; text-decoration: none; background-image: linear-gradient(-90deg, #ebedf5 0%, rgba(235, 237, 245, 0.8) 80%, rgba(235, 237, 245, 0) 100%); }
.site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.passive):nth-child(3) > .nav-list-expander svg { transform: rotate(-90deg); }
.site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.passive):nth-child(3) > .nav-list { display: block; }
.site-nav > .nav-category-list > .nav-list-item:not(.passive) > .nav-list-expander svg { transform: rotate(-90deg); }
.site-nav > .nav-category-list > .nav-list-item:not(.passive) > .nav-list { display: block; }
</style>
<script src="/assets/js/vendor/lunr.min.js"></script>
<script src="/assets/js/just-the-docs.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<!-- Begin Jekyll SEO tag v2.8.0 -->
<title>CLI Reference | Docs</title>
<meta name="generator" content="Jekyll v3.9.3" />
<meta property="og:title" content="CLI Reference" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="lakefs-databricks CLI Reference" />
<meta property="og:description" content="lakefs-databricks CLI Reference" />
<meta property="og:site_name" content="Docs" />
<meta property="og:image" content="https://docs-databricks.lakefs.io/assets/img/docs_logo.png" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:image" content="https://docs-databricks.lakefs.io/assets/img/docs_logo.png" />
<meta property="twitter:title" content="CLI Reference" />
<meta name="twitter:site" content="@lakeFS" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"lakefs-databricks CLI Reference","headline":"CLI Reference","image":"https://docs-databricks.lakefs.io/assets/img/docs_logo.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/assets/lakeFS_for_databricks_logo.svg"}},"url":"/CLI%20Reference.html"}</script>
<!-- End Jekyll SEO tag -->
<!-- Google Tag Manager Head -->
<!-- type="text/plain" is intentional for cookie consent support -->
<script type="text/plain" data-category="analytics">(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-KTZBZW9');</script>
<!-- End Google Tag Manager Head -->
<meta property="og:image" content="/assets/img/lakefs-logo-with-text.png">
<link rel="preload" href="/assets/fonts/Rene Bieder - Galano Grotesque.otf" as="font" type="font/otf" crossorigin>
<link rel="preload" href="/assets/fonts/Rene Bieder - Galano Grotesque Medium.otf" as="font" type="font/otf" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.1/css/fontawesome.min.css" integrity="sha512-giQeaPns4lQTBMRpOOHsYnGw1tGVzbAIHUyHRgn7+6FmiEgGGjaG0T2LZJmAPMzRCl+Cug0ItQ2xDZpTmEc+CQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.1/css/all.min.css" integrity="sha512-MV7K8+y+gLIBoVD59lQIYicR65iaqukzvf/nwasF0nqhPay5w/9lJmVM2hMDcnK1OnMGCdVK+iQrJ7lzPJQd1w==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/orestbida/[email protected]/dist/cookieconsent.css">
<link rel="stylesheet" href="/assets/css/cookieconsent.css" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://ajax.googleapis.com/ajax/libs/jqueryui/1.13.2/themes/smoothness/jquery-ui.css">
<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js"></script>
<script type="module" src="/assets/js/cookieconsent-init.js"></script>
<script src="/assets/js/copy-code.js"></script>
<script>
$(function () {
$(".tabs").tabs();
});
</script>
<script src="/assets/js/feedback.js"></script>
<link href="https://data-folks.masto.host/@lakeFS" rel="me">
</head>
<script src="https://unpkg.com/[email protected]/dist/mermaid.min.js"></script>
<script>
$(document).ready(function () {
mermaid.initialize({
startOnLoad:true,
theme: "default",
});
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
});
</script>
<body>
<img src="/assets/img/cookies.png" style="display: none;">
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KTZBZW9"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-link" viewBox="0 0 24 24">
<title>Link</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-link">
<path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path>
<path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
</svg>
</symbol>
<symbol id="svg-search" viewBox="0 0 24 24">
<title>Search</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-search">
<circle cx="11" cy="11" r="8"></circle>
<line x1="21" y1="21" x2="16.65" y2="16.65"></line>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" width="20px" height="16px" viewBox="0 0 20 16" version="1.1"
class="feather feather-menu">
<g id="Symbols" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
<g id="header-/-mobile" transform="translate(-30.000000, -32.000000)" fill="#279890">
<g id="Group" transform="translate(30.000000, 32.000000)">
<path
d="M20,14 L20,16 L0,16 L0,14 L20,14 Z M20,7 L20,9 L0,9 L0,7 L20,7 Z M20,0 L20,2 L0,2 L0,0 L20,0 Z"
id="mobile-menu" />
</g>
</g>
</g>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-doc" viewBox="0 0 24 24">
<title>Document</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-file">
<path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path>
<polyline points="13 2 13 9 20 9"></polyline>
</svg>
</symbol>
</svg>
<div class="body-wrapper">
<div class="side-bar">
<div class="site-header">
<a href="https://docs-databricks.lakefs.io" class="site-title lh-tight">
<div class="site-logo" role="img" aria-label="Docs"></div>
</a>
<a href="#" id="menu-button" class="site-button">
<svg viewBox="0 0 24 24" class="icon">
<use xlink:href="#svg-menu"></use>
</svg>
</a>
</div>
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
<div class="search">
<div class="search-input-wrap">
<input type="text" id="search-input" class="search-input" tabindex="0"
placeholder="Search Docs" aria-label="Search Docs"
autocomplete="off">
<label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon">
<use xlink:href="#svg-search"></use>
</svg></label>
</div>
<div id="search-results" class="search-results"></div>
</div>
<div class="nav-category nav-version">
<label for="selectversion">Version:</label>
<select id="selectversion" name="version" onchange="javascript:location.href = '/' + encodeURI(this.value);">
<option value="" selected>Latest</option>
</select>
</div>
<script async>
window.addEventListener("load", async () => {
const pathFirstLevel = location.pathname.split('/')[1];
const selectedVersion = pathFirstLevel.startsWith('v') && pathFirstLevel || '';
const selectVersionElmFirst = document.getElementById('selectversion').firstElementChild;
const response = await fetch('/versions.json');
if (!response.ok) {
return
}
const versions = await response.json();
for (let [key, value] of Object.entries(versions)) {
const el = document.createElement("option");
el.value = key;
el.textContent = value;
if (key === selectedVersion) {
el.selected = true;
}
selectVersionElmFirst.after(el);
}
});
</script>
<ul class="nav-list"><li
class="nav-list-item"><a href="/"
class="nav-list-link">lakeFS for Databricks</a></li><li
class="nav-list-item"><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24">
<use xlink:href="#svg-arrow-right"></use>
</svg></a><a href="/getstarted/"
class="nav-list-link">Get Started</a><ul class="nav-list "><li class="nav-list-item "><a href="/getstarted/install.html"
class="nav-list-link">Install</a></li><li class="nav-list-item "><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24">
<use xlink:href="#svg-arrow-right"></use>
</svg></a><a href="/getstarted/setup.html"
class="nav-list-link">Setup</a><ul class="nav-list"></ul></li><li class="nav-list-item "><a href="/getstarted/try-it-out.html"
class="nav-list-link">Try it Out</a></li></ul></li><li
class="nav-list-item active"><a href="/CLI%20Reference.html"
class="nav-list-link active">CLI Reference</a></li><li
class="nav-list-item"><a href="/roadmap.html"
class="nav-list-link">Roadmap</a></li><li
class="nav-list-item"><a href="/faq.html"
class="nav-list-link">FAQ</a></li></ul>
<div class="mobile-menu">
<nav aria-label="Auxiliary" class="aux-nav">
<ul class="aux-nav-list">
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/" class="site-button" >
Docs
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/blog/" class="site-button" >
Blog
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/community/" class="site-button" >
Community
</a>
</li>
<li class="aux-nav-list-item button">
<a href="https://lakefs.io/slack" class="site-button" >
Join us on Slack
</a>
</li>
</ul>
</nav>
</div>
</nav>
</div>
<div class="main" id="top">
<div class="feedback-container">
<div id="is-helpful-ty">
<div class="text-epsilon">Thank you for your feedback.</div>
<div class="mt-2 text-epsilon">
<a href="https://lakefs.io/slack" target="_blank">Join the community</a> to get more help.
</div>
</div>
<div class="feedback-buttons">
<span class="tooltip">
<button class="page-helpful-btn far fa-lg fa-thumbs-up" id="page-helpful-yes"></button>
<span class="tooltiptext">
This page is <b>helpful</b>
</span>
</span>
<span class="tooltip">
<button class="page-helpful-btn far fa-lg fa-thumbs-down" id="page-helpful-no"></button>
<span class="tooltiptext">
This page is <b>not helpful</b>
</span>
</span>
</div>
</div>
<div id="main-header" class="main-header">
<nav aria-label="Auxiliary" class="aux-nav">
<ul class="aux-nav-list">
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/" class="site-button" >
Docs
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/blog/" class="site-button" >
Blog
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/community/" class="site-button" >
Community
</a>
</li>
<li class="aux-nav-list-item button">
<a href="https://lakefs.io/slack" class="site-button" >
Join us on Slack
</a>
</li>
</ul>
</nav>
</div>
<div id="main-content-wrap" class="main-content-wrap">
<div id="main-content" class="main-content" role="main">
<h1 id="lakefs-databricks-cli-reference">
<a href="#lakefs-databricks-cli-reference" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> lakefs-databricks CLI Reference
</h1>
<div class="toc-block">
<h2 class="no_toc text-delta" id="table-of-contents">
<a href="#table-of-contents" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Table of contents
</h2>
<ol id="markdown-toc">
<li><a href="#installing-lakefs-databricks-locally" id="markdown-toc-installing-lakefs-databricks-locally">Installing lakefs-databricks locally</a> <ol>
<li><a href="#cli-configuration" id="markdown-toc-cli-configuration">CLI Configuration</a> <ol>
<li><a href="#configuration-file" id="markdown-toc-configuration-file">Configuration file</a></li>
<li><a href="#environment-variables" id="markdown-toc-environment-variables">Environment variables</a></li>
</ol>
</li>
</ol>
</li>
<li><a href="#command-reference" id="markdown-toc-command-reference">Command Reference</a> <ol>
<li><a href="#commands" id="markdown-toc-commands">Commands</a> <ol>
<li><a href="#catalog-create" id="markdown-toc-catalog-create">catalog create</a></li>
<li><a href="#branch-create" id="markdown-toc-branch-create">branch create</a></li>
<li><a href="#commit" id="markdown-toc-commit">commit</a></li>
</ol>
</li>
</ol>
</li>
</ol>
</div>
<h2 id="installing-lakefs-databricks-locally">
<a href="#installing-lakefs-databricks-locally" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Installing lakefs-databricks locally
</h2>
<p><code class="language-plaintext highlighter-rouge">lakefs-databricks</code> is available for Linux, macOS, and Windows. <br />
TODO: UPDATE LINKS</p>
<p><a href="https://treeverse-tools.s3.amazonaws.com/lakefs-databricks/artifacts/0.3.0/aarch64-apple-darwin/lakefs-databricks-aarch64-apple-darwin-0.3.0.tar.gz">lakefs-databricks-aarch64-apple-darwin-0.3.0.tar.gz</a> <br />
<a href="https://treeverse-tools.s3.amazonaws.com/lakefs-databricks/artifacts/0.3.0/x86_64-apple-darwin/lakefs-databricks-x86_64-apple-darwin-0.3.0.tar.gz">lakefs-databricks-x86_64-apple-darwin-0.3.0.tar.gz</a> <br />
<a href="https://treeverse-tools.s3.amazonaws.com/lakefs-databricks/artifacts/0.3.0/x86_64-pc-windows-msvc/lakefs-databricks-x86_64-pc-windows-msvc-0.3.0.zip">lakefs-databricks-x86_64-pc-windows-msvc-0.3.0.zip</a> <br />
<a href="https://treeverse-tools.s3.amazonaws.com/lakefs-databricks/artifacts/0.3.0/x86_64-unknown-linux-gnu/lakefs-databricks-x86_64-unknown-linux-gnu-0.3.0.tar.gz">lakefs-databricks-x86_64-unknown-linux-gnu-0.3.0.tar.gz</a> <br />
<a href="https://treeverse-tools.s3.amazonaws.com/lakefs-databricks/artifacts/0.3.0/x86_64-unknown-linux-musl/lakefs-databricks-x86_64-unknown-linux-musl-0.3.0.tar.gz">lakefs-databricks-x86_64-unknown-linux-musl-0.3.0.tar.gz</a></p>
<h3 id="cli-configuration">
<a href="#cli-configuration" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> CLI Configuration
</h3>
<p><code class="language-plaintext highlighter-rouge">lakefs-databricks</code> can be configured using either a YAML file or environment variables.</p>
<h4 id="configuration-file">
<a href="#configuration-file" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Configuration file
</h4>
<p>By default, <code class="language-plaintext highlighter-rouge">lakefs-databricks</code> will look for a file named <code class="language-plaintext highlighter-rouge">.lakefs-databricks.yaml</code> in your home directory, but the
configuration file can be specified by passing the <code class="language-plaintext highlighter-rouge">-c</code> (or <code class="language-plaintext highlighter-rouge">--config</code>) argument to <code class="language-plaintext highlighter-rouge">lakefs-databricks</code> (see below).</p>
<div class="tabs">
<ul>
<li><a href="#aws_file">AWS</a></li>
<li><a href="#azure_file">Azure</a></li>
</ul>
<div id="aws_file">
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">unity</span><span class="pi">:</span>
<span class="c1"># The Databricks workspace URL (i.e. https://dbc-<workspace-id>.cloud.databricks.com)</span>
<span class="na">url</span><span class="pi">:</span> <span class="s"><unity_url></span>
<span class="na">token</span><span class="pi">:</span> <span class="s"><unity_token></span>
<span class="na">lakefs</span><span class="pi">:</span>
<span class="na">secret_access_key</span><span class="pi">:</span> <span class="s"><lakefs_secret_access_key></span>
<span class="na">access_key_id</span><span class="pi">:</span> <span class="s"><lakefs_access_key_id></span>
<span class="c1"># Cloud Installation API URL (with suffix /api/v1)</span>
<span class="na">url</span><span class="pi">:</span> <span class="s"><lakefs_installation_url>/api/v1</span>
<span class="na">databricks_storage</span><span class="pi">:</span>
<span class="na">type</span><span class="pi">:</span> <span class="s">s3</span>
<span class="na">s3</span><span class="pi">:</span>
<span class="na">access_key_id</span><span class="pi">:</span> <span class="s"><aws_access_key_id></span>
<span class="na">secret_access_key</span><span class="pi">:</span> <span class="s"><aws_secret_access_key></span>
<span class="na">region</span><span class="pi">:</span> <span class="s"><aws_region></span>
</code></pre></div> </div>
</div>
<div id="azure_file">
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">unity</span><span class="pi">:</span>
<span class="c1"># The Databricks workspace URL (i.e. https://adb-<workspace-id>.azuredatabricks.net)</span>
<span class="na">url</span><span class="pi">:</span> <span class="s"><unity_url></span>
<span class="na">token</span><span class="pi">:</span> <span class="s"><unity_token></span>
<span class="na">lakefs</span><span class="pi">:</span>
<span class="na">secret_access_key</span><span class="pi">:</span> <span class="s"><lakefs_secret_access_key></span>
<span class="na">access_key_id</span><span class="pi">:</span> <span class="s"><lakefs_access_key_id></span>
<span class="c1"># Cloud Installation API URL (with suffix /api/v1)</span>
<span class="na">url</span><span class="pi">:</span> <span class="s"><lakefs_installation_url>/api/v1</span>
<span class="na">databricks_storage</span><span class="pi">:</span>
<span class="na">type</span><span class="pi">:</span> <span class="s">azure</span>
<span class="na">azure</span><span class="pi">:</span>
<span class="na">client_id</span><span class="pi">:</span> <span class="s"><client id></span>
<span class="na">client_secret</span><span class="pi">:</span> <span class="s"><client secret></span>
<span class="na">tenant_id</span><span class="pi">:</span> <span class="s"><tenant id></span>
</code></pre></div> </div>
</div>
</div>
<h4 id="environment-variables">
<a href="#environment-variables" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Environment variables
</h4>
<div class="tabs">
<ul>
<li><a href="#aws_env">AWS</a></li>
<li><a href="#azure_env">Azure</a></li>
</ul>
<div id="aws_env">
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>LAKEFS_DATABRICKS_UNITY_URL=<unity_url>
LAKEFS_DATABRICKS_UNITY_TOKEN=<unity_token>
LAKEFS_DATABRICKS_LAKEFS_URL=<lakefs_installation_url>/api/v1
LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=<lakefs_access_key_id>
LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=<lakefs_secret_access_key>
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=s3
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_ACCESS_KEY_ID=<aws_access_key_id>
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_SECRET_ACCESS_KEY=<aws_secret_access_key>
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_REGION=<aws_region>
</code></pre></div> </div>
</div>
<div id="azure_env">
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>LAKEFS_DATABRICKS_UNITY_URL=<unity_url>
LAKEFS_DATABRICKS_UNITY_TOKEN=<unity_token>
LAKEFS_DATABRICKS_LAKEFS_URL=<lakefs_installation_url>/api/v1
LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=<lakefs_access_key_id>
LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=<lakefs_secret_access_key>
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=azure
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_ID=<client_id>
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_SECRET=<client_secret>
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_TENANT_ID=<tenant_id>
</code></pre></div> </div>
</div>
</div>
<h2 id="command-reference">
<a href="#command-reference" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Command Reference
</h2>
<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>-c, --config <FILE> Config file to use
-h, --help Print help
-V, --version Print version
</code></pre></div></div>
<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks <span class="o">[</span>OPTIONS] <COMMAND>
</code></pre></div></div>
<h3 id="commands">
<a href="#commands" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Commands
</h3>
<h4 id="catalog-create">
<a href="#catalog-create" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> catalog create
</h4>
<p>Create a versioned catalog</p>
<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>--force
Force creation of the catalog even if it already exists.
If specified, the lakeFS repository will be re-associated with the provided Unity catalog. This may have undesired effects.
--sample-catalog
Add sample data to the created catalog
</code></pre></div></div>
<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks catalog create <span class="o">[</span>OPTIONS] <CATALOG_NAME> <LAKEFS_REPO_NAME>
</code></pre></div></div>
<p><strong>Examples</strong></p>
<p>Create a catalog named “my-catalog” mapped to the LakeFS repository “my-repo”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks catalog create my-catalog my-repo
</code></pre></div></div>
<p>Force-create the same catalog, with sample data:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks catalog create <span class="nt">--force</span> <span class="nt">--sample-catalog</span> my-catalog my-repo
</code></pre></div></div>
<h4 id="branch-create">
<a href="#branch-create" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> branch create
</h4>
<p>Create a branch</p>
<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks branch create <LAKEFS_REPO_NAME> <BRANCH_NAME> <SOURCE_BRANCH_NAME>
</code></pre></div></div>
<p><strong>Examples</strong></p>
<p>Create a branch called “my-branch” from the source branch “main”, on the LakeFS repository “my-repo”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks branch create my-repo my-branch main
</code></pre></div></div>
<h4 id="commit">
<a href="#commit" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> commit
</h4>
<p>Record catalog changes</p>
<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>-m, --message <MESSAGE> Commit message
</code></pre></div></div>
<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks commit <span class="o">[</span>OPTIONS] <LAKEFS_REPO_NAME> <BRANCH_ID>
</code></pre></div></div>
<p><strong>Examples</strong></p>
<p>Commit the changes on branch “my-branch” and repo “my-repo”, with commit message “Changes”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks commit <span class="nt">-m</span> <span class="s2">"Changes"</span> my-repo my-branch
</code></pre></div></div>
</div>
</div>
<div class="search-overlay"></div>
</div>
</div>
<footer>
<div class="footer-sidebar"></div>
<div class="footer-main">
<div class="row">
<div class="left">
<ul class="footer-links">
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/" class="site-button" >
Docs
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/blog/" class="site-button" >
Blog
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/community/" class="site-button" >
Community
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/contact-us/" class="site-button" >
Contact
</a>
</li>
</ul>
</div>
<div class="right">
<ul class="footer-social">
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/youtube" class="site-button" >
<img src="/assets/icons/youtube.svg" class="no-hover" />
<img src="/assets/icons/youtube-hover.svg" class="hover" />
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://www.linkedin.com/company/treeverse" class="site-button" >
<img src="/assets/icons/linkedin.svg" class="no-hover" />
<img src="/assets/icons/linkedin-hover.svg" class="hover" />
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://github.com/treeverse/lakeFS" class="site-button" >
<img src="/assets/icons/github.svg" class="no-hover" />
<img src="/assets/icons/github-hover.svg" class="hover" />
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://twitter.com/lakeFS" class="site-button" >
<img src="/assets/icons/twitter.svg" class="no-hover" />
<img src="/assets/icons/twitter-hover.svg" class="hover" />
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://data-folks.masto.host/@lakeFS" class="site-button" >
<img src="/assets/icons/mastodon.svg" class="no-hover" />
<img src="/assets/icons/mastodon-hover.svg" class="hover" />
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/slack" class="site-button" >
<img src="/assets/icons/slack.svg" class="no-hover" />
<img src="/assets/icons/slack-hover.svg" class="hover" />
</a>
</li>
</ul>
</div>
</div>
<div class="row top-border">
<div class="left">
<a href="https://docs-databricks.lakefs.io" class="lh-tight" style="margin-bottom: 0px;">
<div class="site-logo"></div>
</a>
</div>
<div class="right">
<ul class="bottom-footer-links">
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/terms-of-use/" class="site-button" >
Terms of use
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://docs-databricks.lakefs.io/privacy-policy/" class="site-button" >
Privacy Policy
</a>
</li>
</ul>
</div>
</div>
</div>
</footer>
</body>
</html>