-
Notifications
You must be signed in to change notification settings - Fork 1
/
towards-1.0-sdk.html
876 lines (702 loc) · 45.3 KB
/
towards-1.0-sdk.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
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
<!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(8) > .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(8) > .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(8) > .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>lakeFS SDK in 1.0 | lakeFS Documentation</title>
<meta name="generator" content="Jekyll v3.9.3" />
<meta property="og:title" content="lakeFS SDK in 1.0" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="lakeFS - Data version control for your data lake Git for data" />
<meta property="og:description" content="lakeFS - Data version control for your data lake Git for data" />
<meta property="og:site_name" content="lakeFS Documentation" />
<meta property="og:image" content="https://docs.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.lakefs.io/assets/img/docs_logo.png" />
<meta property="twitter:title" content="lakeFS SDK in 1.0" />
<meta name="twitter:site" content="@lakeFS" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"lakeFS - Data version control for your data lake Git for data","headline":"lakeFS SDK in 1.0","image":"https://docs.lakefs.io/assets/img/docs_logo.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/assets/logo.svg"}},"url":"/posts/towards-1.0-sdk.html"}</script>
<!-- End Jekyll SEO tag -->
<!-- Google Tag Manager Head -->
<!-- type="text/plain" is intentional for cookie consent support -->
<script type="text/plain" data-cookiecategory="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="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="/assets/css/cookieconsent.css" media="print" onload="this.media = 'all'" />
<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 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">
<script defer src="/assets/js/cookieconsent.js"></script>
<script defer src="/assets/js/cookieconsent-init.js"></script>
</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>
<!-- 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://lakefs.io" class="site-title lh-tight">
<div class="site-logo" role="img" aria-label="lakeFS Documentation"></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 lakeFS Documentation" aria-label="Search lakeFS Documentation"
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">Welcome to lakeFS 👋🏻</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="/quickstart/"
class="nav-list-link">⭐ Quickstart ⭐</a><ul class="nav-list "><li class="nav-list-item "><a href="/quickstart/launch.html"
class="nav-list-link">1️⃣ Run lakeFS</a></li><li class="nav-list-item "><a href="/quickstart/query.html"
class="nav-list-link">2️⃣ Query the data</a></li><li class="nav-list-item "><a href="/quickstart/branch.html"
class="nav-list-link">3️⃣ Create a branch</a></li><li class="nav-list-item "><a href="/quickstart/commit-and-merge.html"
class="nav-list-link">4️⃣ Commit and Merge</a></li><li class="nav-list-item "><a href="/quickstart/rollback.html"
class="nav-list-link">5️⃣ Roll back Changes</a></li><li class="nav-list-item "><a href="/quickstart/actions-and-hooks.html"
class="nav-list-link">6️⃣ Using Actions and Hooks in lakeFS</a></li><li class="nav-list-item "><a href="/quickstart/learning-more-lakefs.html"
class="nav-list-link">🧑🏻🎓 Learn more about lakeFS</a></li></ul></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="/howto/"
class="nav-list-link">How-To</a><ul class="nav-list "><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="/howto/deploy/"
class="nav-list-link">Install lakeFS</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/howto/deploy/aws.html"
class="nav-list-link">AWS</a>
</li><li class="nav-list-item ">
<a href="/howto/deploy/azure.html"
class="nav-list-link">Azure</a>
</li><li class="nav-list-item ">
<a href="/howto/deploy/gcp.html"
class="nav-list-link">GCP</a>
</li><li class="nav-list-item ">
<a href="/howto/deploy/onprem.html"
class="nav-list-link">On-Premises</a>
</li><li class="nav-list-item ">
<a href="/howto/deploy/upgrade.html"
class="nav-list-link">Upgrade lakeFS</a>
</li></ul></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="/howto/hooks/"
class="nav-list-link">Actions and Hooks</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/howto/hooks/airflow.html"
class="nav-list-link">Airflow Hooks</a>
</li><li class="nav-list-item ">
<a href="/howto/hooks/lua.html"
class="nav-list-link">Lua Hooks</a>
</li><li class="nav-list-item ">
<a href="/howto/hooks/webhooks.html"
class="nav-list-link">Webhooks</a>
</li></ul></li><li class="nav-list-item "><a href="/howto/copying.html"
class="nav-list-link">Copying data to/from lakeFS</a></li><li class="nav-list-item "><a href="/howto/export.html"
class="nav-list-link">Export Data</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="/howto/garbage-collection/"
class="nav-list-link">Garbage Collection</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/howto/garbage-collection/gc.html"
class="nav-list-link">Garbage Collection</a>
</li><li class="nav-list-item ">
<a href="/howto/garbage-collection/managed-gc.html"
class="nav-list-link">Managed Garbage Collection</a>
</li></ul></li><li class="nav-list-item "><a href="/howto/import.html"
class="nav-list-link">Import Data</a></li><li class="nav-list-item "><a href="/howto/migrate-away.html"
class="nav-list-link">Migrating away from lakeFS</a></li><li class="nav-list-item "><a href="/howto/private-link.html"
class="nav-list-link">Private Link</a></li><li class="nav-list-item "><a href="/howto/protect-branches.html"
class="nav-list-link">Protect Branches</a></li><li class="nav-list-item "><a href="/howto/sizing-guide.html"
class="nav-list-link">Sizing Guide</a></li></ul></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="/integrations/"
class="nav-list-link">Integrations</a><ul class="nav-list "><li class="nav-list-item "><a href="/integrations/aws_cli.html"
class="nav-list-link">AWS CLI</a></li><li class="nav-list-item "><a href="/integrations/airbyte.html"
class="nav-list-link">Airbyte</a></li><li class="nav-list-item "><a href="/integrations/athena.html"
class="nav-list-link">Amazon Athena</a></li><li class="nav-list-item "><a href="/integrations/sagemaker.html"
class="nav-list-link">Amazon SageMaker</a></li><li class="nav-list-item "><a href="/integrations/airflow.html"
class="nav-list-link">Apache Airflow</a></li><li class="nav-list-item "><a href="/integrations/hive.html"
class="nav-list-link">Apache Hive</a></li><li class="nav-list-item "><a href="/integrations/iceberg.html"
class="nav-list-link">Apache Iceberg</a></li><li class="nav-list-item "><a href="/integrations/kafka.html"
class="nav-list-link">Apache Kafka</a></li><li class="nav-list-item "><a href="/integrations/spark.html"
class="nav-list-link">Apache Spark</a></li><li class="nav-list-item "><a href="/integrations/cloudera.html"
class="nav-list-link">Cloudera</a></li><li class="nav-list-item "><a href="/integrations/delta.html"
class="nav-list-link">Delta Lake</a></li><li class="nav-list-item "><a href="/integrations/dremio.html"
class="nav-list-link">Dremio</a></li><li class="nav-list-item "><a href="/integrations/duckdb.html"
class="nav-list-link">DuckDB</a></li><li class="nav-list-item "><a href="/integrations/glue_hive_metastore.html"
class="nav-list-link">Glue / Hive metastore</a></li><li class="nav-list-item "><a href="/integrations/kubeflow.html"
class="nav-list-link">Kubeflow</a></li><li class="nav-list-item "><a href="/integrations/presto_trino.html"
class="nav-list-link">Presto / Trino</a></li><li class="nav-list-item "><a href="/integrations/python.html"
class="nav-list-link">Python</a></li><li class="nav-list-item "><a href="/integrations/r.html"
class="nav-list-link">R</a></li><li class="nav-list-item "><a href="/integrations/vertex_ai.html"
class="nav-list-link">Vertex AI</a></li></ul></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="/understand/"
class="nav-list-link">Understanding lakeFS</a><ul class="nav-list "><li class="nav-list-item "><a href="/understand/architecture.html"
class="nav-list-link">Architecture</a></li><li class="nav-list-item "><a href="/understand/model.html"
class="nav-list-link">Concepts and Model</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="/understand/data_lifecycle_management/"
class="nav-list-link">Data Lifecycle Management</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/understand/data_lifecycle_management/ci.html"
class="nav-list-link">During Deployment</a>
</li><li class="nav-list-item ">
<a href="/understand/data_lifecycle_management/production.html"
class="nav-list-link">In Production</a>
</li><li class="nav-list-item ">
<a href="/understand/data_lifecycle_management/data-devenv.html"
class="nav-list-link">In Test</a>
</li></ul></li><li class="nav-list-item "><a href="/understand/faq.html"
class="nav-list-link">FAQ</a></li><li class="nav-list-item "><a href="/understand/glossary.html"
class="nav-list-link">Glossary</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="/understand/how/"
class="nav-list-link">How lakeFS Works</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/understand/how/kv.html"
class="nav-list-link">Internal database structure</a>
</li><li class="nav-list-item ">
<a href="/understand/how/merge.html"
class="nav-list-link">Merge</a>
</li><li class="nav-list-item ">
<a href="/understand/how/versioning-internals.html"
class="nav-list-link">Versioning Internals</a>
</li></ul></li><li class="nav-list-item "><a href="/understand/performance-best-practices.html"
class="nav-list-link">Performance Best Practices</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="/understand/use_cases/"
class="nav-list-link">Use Cases</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/understand/use_cases/cicd_for_data.html"
class="nav-list-link">CI/CD for Data Lakes</a>
</li><li class="nav-list-item ">
<a href="/understand/use_cases/etl_testing.html"
class="nav-list-link">ETL Testing Environment</a>
</li><li class="nav-list-item ">
<a href="/understand/use_cases/reproducibility.html"
class="nav-list-link">Reproducibility</a>
</li><li class="nav-list-item ">
<a href="/understand/use_cases/rollback.html"
class="nav-list-link">Rollback</a>
</li></ul></li><li class="nav-list-item "><a href="/understand/lakefs-cloud.html"
class="nav-list-link">lakeFS Cloud</a></li><li class="nav-list-item "><a href="/understand/lakefs-enterprise.html"
class="nav-list-link">lakeFS Enterprise</a></li></ul></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="/reference/"
class="nav-list-link">Reference</a><ul class="nav-list "><li class="nav-list-item "><a href="/reference/auditing.html"
class="nav-list-link">Auditing</a></li><li class="nav-list-item "><a href="/reference/monitor.html"
class="nav-list-link">Monitoring using Prometheus</a></li><li class="nav-list-item "><a href="/reference/s3.html"
class="nav-list-link">S3 Gateway API</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="/reference/security/"
class="nav-list-link">Security</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/reference/security/access-control-lists.html"
class="nav-list-link">Access Control Lists (ACLs)</a>
</li><li class="nav-list-item ">
<a href="/reference/security/authentication.html"
class="nav-list-link">Authentication</a>
</li><li class="nav-list-item ">
<a href="/reference/security/presigned-url.html"
class="nav-list-link">Presigned URL</a>
</li><li class="nav-list-item ">
<a href="/reference/security/remote-authenticator.html"
class="nav-list-link">Remote Authenticator</a>
</li><li class="nav-list-item ">
<a href="/reference/security/rbac.html"
class="nav-list-link">Role-Based Access Control (RBAC)</a>
</li></ul></li><li class="nav-list-item "><a href="/reference/spark-client.html"
class="nav-list-link">Spark Client</a></li><li class="nav-list-item "><a href="/reference/api.html"
class="nav-list-link">lakeFS API</a></li><li class="nav-list-item "><a href="/reference/configuration.html"
class="nav-list-link">lakeFS Server Configuration</a></li><li class="nav-list-item "><a href="/reference/cli.html"
class="nav-list-link">lakectl (lakeFS command-line tool)</a></li></ul></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="/project/"
class="nav-list-link">The lakeFS Project</a><ul class="nav-list "><li class="nav-list-item "><a href="/project/contributing.html"
class="nav-list-link">Contributing to lakeFS</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="/project/docs/"
class="nav-list-link">Documentation</a><ul class="nav-list"><li class="nav-list-item ">
<a href="/project/docs/callouts.html"
class="nav-list-link">Callouts</a>
</li></ul></li></ul></li><li
class="nav-list-item active"><a href="/posts/towards-1.0-sdk.html"
class="nav-list-link active">lakeFS SDK in 1.0</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.lakefs.io/" class="site-button" >
Docs
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/blog/" class="site-button" >
Blog
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/community/" class="site-button" >
Community
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://github.com/treeverse/lakeFS" class="site-button" >
GitHub
</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.lakefs.io/" class="site-button" >
Docs
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/blog/" class="site-button" >
Blog
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/community/" class="site-button" >
Community
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://github.com/treeverse/lakeFS" class="site-button" >
GitHub
</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-sdk-in-10">
<a href="#lakefs-sdk-in-10" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> lakeFS SDK in 1.0
</h1>
<p><img src="file:./images/1.0-is-coming.jpg" height="500px" alt="1.0 is coming: a double rainbow over a traffic jam in Tel Aviv" /></p>
<h2 id="goals">
<a href="#goals" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Goals
</h2>
<p>We are putting the finishing touches on the :sparkles: lakeFS 1.0 release
:sparkles:. Part of the reason 1.0 is so important is that it promises
stability to lakeFS users and to lakeFS developers.</p>
<p>lakeFS version numbers generally follow <a href="https://semver.org/">Semantic
Versioning</a>. Version <strong>1.0.0</strong> will be the first major
version, so it will be the first version to promise <em>major version
stability</em>. A brief summary of semantic versioning: Starting with this
version,</p>
<ul>
<li><strong>Patch</strong> version upgrades (for instance, from 1.0.0 to 1.0.1, or from
1.3.11 to 1.3.12) can fix bugs but cannot add new API capabilities. All
programs that worked with the previous version continue to work with the
new version. All programs that work with the new version and are
unaffected by the fixed bugs would work with the old version.</li>
<li><strong>Minor</strong> version upgrades (for instance, from 1.0.0 to 1.1.0, or from
1.3.11 to 1.4.0) can add API capabilities but cannot change existing APIs.
All programs that worked with the previous version continue to work with
the new version.</li>
<li><strong>Major</strong> version upgrades (for instance, from 1.4.0 to 2.0.0, or from
1.17.12 to 2.0.0) can add, remove, or change existing APIs entirely. A
program might stop working.</li>
</ul>
<p>So it’s a pretty important change! Up until now, even a bump from 0.104.0
to 0.105.0 could break old programs. Indeed that happened. Starting with
1.0.0, a minor version that breaks old programs is a bug.</p>
<h2 id="100-is-a-major-version-upgrade">
<a href="#100-is-a-major-version-upgrade" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> 1.0.0 is a <strong>major</strong> version upgrade!
</h2>
<p>All guarantees here are for minor version upgrades. The upgrade to 1.0.0 is
of course a <strong>major version upgrade</strong>, and it will necessarily break some
client programs.</p>
<h2 id="interface-guarantees">
<a href="#interface-guarantees" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Interface guarantees
</h2>
<p>To detail what 1.0 really promises, we need to list what are the lakeFS
interfaces. Obviously a program that relies on an internal implementation
detail of lakeFS can fail at any version.</p>
<p>Starting with the 1.0 release, we will maintain stability across the
following interfaces:</p>
<ul>
<li>
<p>Any call to the <a href="https://docs.lakefs.io/reference/api.html">REST OpenAPI API
endpoint</a> is stable, except for
APIs tagged “experimental”, “internal”, or “deprecated”.</p>
<p>If your program only calls such SDKs, it will continue to work across
minor version upgrades.<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">1</a></sup></p>
</li>
<li>
<p>Any call to such an interface through the published, generated SDKs.
These include:</p>
<ul>
<li><a href="https://pypi.org/project/lakefs-sdk/">Python <code class="language-plaintext highlighter-rouge">lakefs-sdk</code></a></li>
<li><a href="https://mvnrepository.com/artifact/io.lakefs/lakefs-sdk">Java Maven <code class="language-plaintext highlighter-rouge">io.lakefs:lakefs-sdk</code></a></li>
</ul>
<p>If your program only uses such calls on the SDK, it will continue to
compile and function across a minor version upgrade of the SDK.</p>
</li>
<li>Any objects that were uploaded to some branch on a lakeFS server and then
committed will continue to work after a minor version upgrade to the
lakeFS server. Running an upgrade script may be required. However
running this upgrade script on a cluster of more than a single server
should not require downtime.<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">2</a></sup></li>
<li>The lakectl CLI flags will continue to work across minor version upgrades.
However we do not currently guarantee the format of lakectl output.</li>
<li>Obviously we do <em>not</em> control the S3 API or its many clients. If your
program uses an S3 API that lakeFS supports, it should continue to work
across a minor version upgrade of lakeFS. A minor version upgrade will
not remove support for a documented S3 API that is supported in the
previous version.</li>
</ul>
<h2 id="why-this-is-important">
<a href="#why-this-is-important" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Why this is important
</h2>
<h3 id="for-users">
<a href="#for-users" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> For users
</h3>
<p>Programs that worked with one version >=1.0.0 of lakeFS should continue to
work with all higher versions <2.0.0. A minor version upgrade only <em>adds</em>
to your capabilities, but you do not need to do anything if you don’t use
the added capabilities.</p>
<h3 id="for-developers">
<a href="#for-developers" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> For developers
</h3>
<p>Don’t use APIs tagged “experimental”, “internal”, or “deprecated”. If you
do use them, the rest of this section does not apply. Take into account
that you may need to modify your program to match any lakeFS server upgrade.</p>
<p>Your program should continue to work with all lakeFS server versions that
are minor version upgrades from the version you used to develop them.</p>
<p>Additionally, if you depend on one of the published, generated SDKs, then
that dependency itself also honours semantic versioning. Switching your
program to a minor version upgrade of the SDK dependency should be seamless.</p>
<h4 id="java">
<a href="#java" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Java
</h4>
<p>For Java and for other languages running on the JVM, the current generated
SDK is <em>not</em> stable with respect to a minor version upgrade. The upgrade
from <code class="language-plaintext highlighter-rouge">io.lakefs:lakefs-client</code> to <code class="language-plaintext highlighter-rouge">io.lakefs:lakefs-sdk</code> will require you to
rewrite API calls in a new style.</p>
<p>Here is <a href="https://github.com/treeverse/lakeFS/pull/6529/files#diff-4c50b9ac3bf6bfc05e3b6ff0fbe2fd3214f31afb5b449732d90efe5f97f67167R666">one example of such a change</a>.
Old calls looked like this:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">ObjectStats</span> <span class="n">objectStat</span> <span class="o">=</span> <span class="n">objectsApi</span><span class="o">.</span><span class="na">statObject</span><span class="o">(</span>
<span class="n">objectLoc</span><span class="o">.</span><span class="na">getRepository</span><span class="o">(),</span> <span class="n">objectLoc</span><span class="o">.</span><span class="na">getRef</span><span class="o">(),</span> <span class="n">objectLoc</span><span class="o">.</span><span class="na">getPath</span><span class="o">(),</span>
<span class="kc">false</span><span class="o">,</span> <span class="kc">false</span><span class="o">);</span>
</code></pre></div></div>
<p>A single call was a single function call, which had to include optional
parameters. If an optional parameter were added, this call would no longer
compile. The long argument lists were also a maintenance burden.</p>
<p>Conceptually, API calls in the SDK now follow a fluent style:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">ObjectStats</span> <span class="n">objectStat</span> <span class="o">=</span> <span class="n">objectsApi</span>
<span class="o">.</span><span class="na">statObject</span><span class="o">(</span>
<span class="n">objectLoc</span><span class="o">.</span><span class="na">getRepository</span><span class="o">(),</span> <span class="n">objectLoc</span><span class="o">.</span><span class="na">getRef</span><span class="o">(),</span> <span class="n">objectLoc</span><span class="o">.</span><span class="na">getPath</span><span class="o">()</span>
<span class="o">)</span>
<span class="o">.</span><span class="na">userMetadata</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">execute</span><span class="o">();</span>
</code></pre></div></div>
<p>The <code class="language-plaintext highlighter-rouge">statObject</code> call of the objects API starts by passing all required
parameters. Then any optional parameters may be changed. Here
<code class="language-plaintext highlighter-rouge">userMetadata</code> is modified, but <code class="language-plaintext highlighter-rouge">presign</code> is kept at its default value.
Finally, the call is <em>executed</em>. When an optional parameter is added, this
call will simply use its default value. This keeps the code compatible with
minor version upgrades of the server.</p>
<h3 id="for-administrators">
<a href="#for-administrators" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> For administrators
</h3>
<p>Your users and your developers no longer need to keep their program versions
in lockstep with your lakeFS server versions, as long as you <strong>apply only
minor version upgrades</strong>.</p>
<p>And if your cluster of lakeFS servers has more than one member, you should
be able to perform most minor version upgrades with no downtime.</p>
<div class="footnotes" role="doc-endnotes">
<ol>
<li id="fn:1" role="doc-endnote">
<p>Unless it depends on a bug that was fixed, of course. <a href="#fnref:1" class="reversefootnote" role="doc-backlink">↩</a></p>
</li>
<li id="fn:2" role="doc-endnote">
<p>Of course this may not be possible with some severe bugfixes.
Requiring server downtime is a measure of the severity of the bugfix. <a href="#fnref:2" class="reversefootnote" role="doc-backlink">↩</a></p>
</li>
</ol>
</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.lakefs.io/" class="site-button" >
Docs
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/blog/" class="site-button" >
Blog
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://github.com/treeverse/lakeFS" class="site-button" >
GitHub
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/community/" class="site-button" >
Community
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/cloud-registration/" class="site-button" >
lakeFS Cloud
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://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://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://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://lakefs.io/terms-of-use/" class="site-button" >
Terms of use
</a>
</li>
<li class="aux-nav-list-item">
<a href="https://lakefs.io/privacy-policy/" class="site-button" >
Privacy Policy
</a>
</li>
</ul>
</div>
</div>
</div>
</footer>
</body>
</html>