-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathz_ibis-for-sql-users – Ibis.html
More file actions
3072 lines (3036 loc) · 286 KB
/
z_ibis-for-sql-users – Ibis.html
File metadata and controls
3072 lines (3036 loc) · 286 KB
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
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.55">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>ibis-for-sql-users – Ibis</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
/* CSS for syntax highlighting */
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
}
pre.numberSource { margin-left: 3em; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
</style>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js" integrity="sha512-bLT0Qm9VnAYZDflyKcBaQ2gg0hSYNQrJ8RilYldYQ1FxQYoCLtUjuuRuZo+fjqhx/qtq/1itJ0C2ejDxltZVFg==" crossorigin="anonymous"></script><script src="../site_libs/quarto-nav/quarto-nav.js"></script>
<script src="../site_libs/quarto-nav/headroom.min.js"></script>
<script src="../site_libs/clipboard/clipboard.min.js"></script>
<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
<script src="../site_libs/quarto-search/fuse.min.js"></script>
<script src="../site_libs/quarto-search/quarto-search.js"></script>
<script src="../site_libs/quarto-search/autocomplete-preset-algolia.umd.js"></script>
<meta name="quarto:offset" content="../">
<link href="../logo.svg" rel="icon" type="image/svg+xml">
<script src="../site_libs/quarto-html/quarto.js"></script>
<script src="../site_libs/quarto-html/popper.min.js"></script>
<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
<script src="../site_libs/quarto-html/anchor.min.js"></script>
<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
<link href="../site_libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-dark.css" rel="prefetch" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap.min.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-dark.min.css" rel="prefetch" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
"collapse-after": 3,
"panel-placement": "end",
"type": "overlay",
"limit": 50,
"algolia": {
"application-id": "TNU9HG3L41",
"search-only-api-key": "26350948d1961209df16d9717a7e01d6",
"index-name": "prod_ibis",
"analytics-events": true,
"show-logo": true,
"libDir": "site_libs"
},
"keyboard-shortcut": [
"f",
"/",
"s"
],
"language": {
"search-no-results-text": "No results",
"search-matching-documents-text": "matching documents",
"search-copy-link-title": "Copy link to search",
"search-hide-matches-text": "Hide additional matches",
"search-more-match-text": "more match in this document",
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-text-placeholder": "",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
}
}</script>
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@4.5.1/dist/algoliasearch-lite.umd.js"></script>
<script type="text/javascript">
var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights/dist/search-insights.iife.min.js";
!function(e,a,t,n,s,i,c){e.AlgoliaAnalyticsObject=s,e[s]=e[s]||function(){
(e[s].queue=e[s].queue||[]).push(arguments)},i=a.createElement(t),c=a.getElementsByTagName(t)[0],
i.async=1,i.src=n,c.parentNode.insertBefore(i,c)
}(window,document,"script",ALGOLIA_INSIGHTS_SRC,"aa");
</script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@algolia/autocomplete-plugin-algolia-insights">
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" integrity="sha512-c3Nl8+7g4LMSTdrm621y7kf9v3SDPnhxLNhcjFJbKECVnmZHTdo+IRO05sNLTH/D3vA6u1X32ehoLC7WFVdheg==" crossorigin="anonymous"></script>
<script type="application/javascript">define('jquery', [],function() {return window.jQuery;})</script>
<script data-goatcounter="https://ibis.goatcounter.com/count" async="" src="//gc.zgo.at/count.js"></script>
<link rel="stylesheet" href="../styles.css">
<meta property="og:title" content="Ibis">
<meta property="og:description" content="the portable Python dataframe library">
<meta property="og:image" content="https://ibis-project.org/tutorials/logo.png">
<meta property="og:site_name" content="Ibis">
<meta name="twitter:title" content="Ibis">
<meta name="twitter:description" content="the portable Python dataframe library">
<meta name="twitter:image" content="https://ibis-project.org/tutorials/logo.png">
<meta name="twitter:card" content="summary_large_image">
</head>
<body class="nav-sidebar floating nav-fixed">
<div id="quarto-search-results"></div>
<header id="quarto-header" class="headroom fixed-top">
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
<div class="navbar-container container-fluid">
<div class="navbar-brand-container mx-auto">
<a class='navbar-brand navbar-brand-logo' href='/'>
<img src="../logo.svg" alt="" class="navbar-logo">
</a>
<a class='navbar-brand' href='/'>
<span class="navbar-title">Ibis</span>
</a>
</div>
<div id="quarto-search" class="" title="Search"></div>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarCollapse">
<ul class="navbar-nav navbar-nav-scroll me-auto">
<li class="nav-item dropdown ">
<a class="nav-link dropdown-toggle" href="#" id="nav-menu-getting-started" role="link" data-bs-toggle="dropdown" aria-expanded="false">
<span class="menu-text">Getting started</span>
</a>
<ul class="dropdown-menu" aria-labelledby="nav-menu-getting-started">
<li>
<a class='dropdown-item' href='/install'>
<span class="dropdown-text">Installation</span></a>
</li>
<li>
<a class='dropdown-item' href='/tutorials/getting_started'>
<span class="dropdown-text">Tutorial: getting started</span></a>
</li>
<li>
<a class='dropdown-item' href='/tutorials/ibis-for-dplyr-users'>
<span class="dropdown-text">Tutorial: Ibis for dplyr users</span></a>
</li>
<li>
<a class='dropdown-item' href='/tutorials/ibis-for-pandas-users'>
<span class="dropdown-text">Tutorial: Ibis for pandas users</span></a>
</li>
<li>
<a class='dropdown-item' href='/tutorials/ibis-for-sql-users'>
<span class="dropdown-text">Tutorial: Ibis for SQL users</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Browser</li>
<li>
<a class='dropdown-item' href='/tutorials/browser/repl'>
<span class="dropdown-text">JupyterLite console</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Cloud Data Platforms</li>
<li>
<a class='dropdown-item' href='/tutorials/cloud-data-platforms/clickhouse'>
<span class="dropdown-text">ClickHouse</span></a>
</li>
<li>
<a class='dropdown-item' href='/tutorials/cloud-data-platforms/starburst-galaxy/0_setup'>
<span class="dropdown-text">Starburst Galaxy</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Open Source Software</li>
<li>
<a class='dropdown-item' href='/tutorials/open-source-software/apache-flink/0_setup'>
<span class="dropdown-text">Apache Flink</span></a>
</li>
</ul>
</li>
<li class="nav-item dropdown ">
<a class="nav-link dropdown-toggle" href="#" id="nav-menu-concepts" role="link" data-bs-toggle="dropdown" aria-expanded="false">
<span class="menu-text">Concepts</span>
</a>
<ul class="dropdown-menu" aria-labelledby="nav-menu-concepts">
<li>
<a class='dropdown-item' href='/why'>
<span class="dropdown-text">Why Ibis?</span></a>
</li>
<li>
<a class='dropdown-item' href='/concepts/composable-ecosystem'>
<span class="dropdown-text">Composable data ecosystem</span></a>
</li>
<li>
<a class='dropdown-item' href='/concepts/datatypes'>
<span class="dropdown-text">Datatypes and Datashapes</span></a>
</li>
<li>
<a class='dropdown-item' href='/concepts/internals'>
<span class="dropdown-text">Internals</span></a>
</li>
<li>
<a class='dropdown-item' href='/concepts/user-testimonials'>
<span class="dropdown-text">User testimonials</span></a>
</li>
<li>
<a class='dropdown-item' href='/concepts/versioning'>
<span class="dropdown-text">Versioning policy</span></a>
</li>
<li>
<a class='dropdown-item' href='/concepts/who'>
<span class="dropdown-text">Who supports Ibis?</span></a>
</li>
</ul>
</li>
<li class="nav-item dropdown ">
<a class="nav-link dropdown-toggle" href="#" id="nav-menu-backends" role="link" data-bs-toggle="dropdown" aria-expanded="false">
<span class="menu-text">Backends</span>
</a>
<ul class="dropdown-menu" aria-labelledby="nav-menu-backends">
<li>
<a class='dropdown-item' href='/backends/bigquery'>
<span class="dropdown-text">BigQuery</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/clickhouse'>
<span class="dropdown-text">ClickHouse</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/dask'>
<span class="dropdown-text">Dask</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/datafusion'>
<span class="dropdown-text">DataFusion</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/druid'>
<span class="dropdown-text">Druid</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/duckdb'>
<span class="dropdown-text">DuckDB</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/exasol'>
<span class="dropdown-text">Exasol</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/flink'>
<span class="dropdown-text">Flink</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/impala'>
<span class="dropdown-text">Impala</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/mssql'>
<span class="dropdown-text">MSSQL</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/mysql'>
<span class="dropdown-text">MySQL</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/oracle'>
<span class="dropdown-text">Oracle</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/pandas'>
<span class="dropdown-text">pandas</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/polars'>
<span class="dropdown-text">Polars</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/postgresql'>
<span class="dropdown-text">PostgreSQL</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/pyspark'>
<span class="dropdown-text">PySpark</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/risingwave'>
<span class="dropdown-text">RisingWave</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/snowflake'>
<span class="dropdown-text">Snowflake</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/sqlite'>
<span class="dropdown-text">SQLite</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/trino'>
<span class="dropdown-text">Trino</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Support</li>
<li>
<a class='dropdown-item' href='/backends/support/matrix'>
<span class="dropdown-text">Operation support matrix</span></a>
</li>
<li>
<a class='dropdown-item' href='/backends/support/operations'>
<span class="dropdown-text">Operations</span></a>
</li>
</ul>
</li>
<li class="nav-item dropdown ">
<a class="nav-link dropdown-toggle" href="#" id="nav-menu-how-to" role="link" data-bs-toggle="dropdown" aria-expanded="false">
<span class="menu-text">How-to</span>
</a>
<ul class="dropdown-menu" aria-labelledby="nav-menu-how-to">
<li class="dropdown-header">Configure</li>
<li>
<a class='dropdown-item' href='/how-to/configure/basics'>
<span class="dropdown-text">Basic configuration</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Input Output</li>
<li>
<a class='dropdown-item' href='/how-to/input-output/basics'>
<span class="dropdown-text">Basic input/output</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/input-output/duckdb-parquet'>
<span class="dropdown-text">Read parquet files with Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/input-output/gcs_duckdb'>
<span class="dropdown-text">Loading Google Cloud Storage files with DuckDB</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/input-output/multiple-backends'>
<span class="dropdown-text">Work with multiple backends</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Analytics</li>
<li>
<a class='dropdown-item' href='/how-to/analytics/basics'>
<span class="dropdown-text">Basic analytics</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/analytics/chain_expressions'>
<span class="dropdown-text">Chaining expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/analytics/imdb'>
<span class="dropdown-text">Analyze IMDB data using Ibis</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Visualization</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/altair'>
<span class="dropdown-text">Altair + Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/graphs'>
<span class="dropdown-text">GraphViz + Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/matplotlib'>
<span class="dropdown-text">matplotlib + Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/plotly'>
<span class="dropdown-text">Plotly + Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/plotnine'>
<span class="dropdown-text">plotnine + Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/seaborn'>
<span class="dropdown-text">seaborn + Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/visualization/streamlit'>
<span class="dropdown-text">Streamlit + Ibis</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Extending</li>
<li>
<a class='dropdown-item' href='/how-to/extending/builtin'>
<span class="dropdown-text">Reference built-in functions</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/extending/sql'>
<span class="dropdown-text">Using SQL strings with Ibis</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/extending/streaming'>
<span class="dropdown-text">Ibis for streaming</span></a>
</li>
<li>
<a class='dropdown-item' href='/how-to/extending/unbound_expression'>
<span class="dropdown-text">Write and execute unbound expressions</span></a>
</li>
</ul>
</li>
<li class="nav-item dropdown ">
<a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
<span class="menu-text">Reference</span>
</a>
<ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
<li class="dropdown-header">Expression API</li>
<li>
<a class='dropdown-item' href='/reference/expression-tables'>
<span class="dropdown-text">Table expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/selectors'>
<span class="dropdown-text">Column selectors</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/expression-generic'>
<span class="dropdown-text">Generic expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/expression-numeric'>
<span class="dropdown-text">Numeric and Boolean expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/expression-strings'>
<span class="dropdown-text">String expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/expression-temporal'>
<span class="dropdown-text">Temporal expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/expression-collections'>
<span class="dropdown-text">Collection expressions</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/expression-geospatial'>
<span class="dropdown-text">Geospatial expressions</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Type system</li>
<li>
<a class='dropdown-item' href='/reference/datatypes'>
<span class="dropdown-text">Data types</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/schemas'>
<span class="dropdown-text">Schemas</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">UDFs</li>
<li>
<a class='dropdown-item' href='/reference/scalar-udfs'>
<span class="dropdown-text">Scalar UDFs</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/aggregate-udfs'>
<span class="dropdown-text">Aggregate UDFs (experimental)</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Connection APIs</li>
<li>
<a class='dropdown-item' href='/reference/connection'>
<span class="dropdown-text">Top-level connection APIs</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header">Configuration</li>
<li>
<a class='dropdown-item' href='/reference/interactive'>
<span class="dropdown-text">Interactive</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/options'>
<span class="dropdown-text">Options</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/repr'>
<span class="dropdown-text">Repr</span></a>
</li>
<li>
<a class='dropdown-item' href='/reference/sql'>
<span class="dropdown-text">SQL</span></a>
</li>
</ul>
</li>
</ul>
<ul class="navbar-nav navbar-nav-scroll ms-auto">
<li class="nav-item">
<a class='nav-link' href='/posts'>
<span class="menu-text">Posts</span></a>
</li>
<li class="nav-item">
<a class='nav-link' href='/presentations'>
<span class="menu-text">Presentations</span></a>
</li>
<li class="nav-item">
<a class='nav-link' href='/release_notes'>
<span class="menu-text">Release notes</span></a>
</li>
<li class="nav-item dropdown ">
<a class="nav-link dropdown-toggle" href="#" id="nav-menu-contribute" role="link" data-bs-toggle="dropdown" aria-expanded="false">
<span class="menu-text">Contribute</span>
</a>
<ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-contribute">
<li class="dropdown-header">Contribute</li>
<li>
<a class='dropdown-item' href='/contribute/01_environment'>
<span class="dropdown-text">Setting up a development environment</span></a>
</li>
<li>
<a class='dropdown-item' href='/contribute/02_workflow'>
<span class="dropdown-text">Contribute to the Ibis codebase</span></a>
</li>
<li>
<a class='dropdown-item' href='/contribute/03_style'>
<span class="dropdown-text">Style and formatting</span></a>
</li>
<li>
<a class='dropdown-item' href='/contribute/04_maintainers_guide'>
<span class="dropdown-text">Maintaining the codebase</span></a>
</li>
<li>
<a class='dropdown-item' href='/contribute/05_reference'>
<span class="dropdown-text">Test class reference</span></a>
</li>
</ul>
</li>
</ul>
</div> <!-- /navcollapse -->
<div class="quarto-navbar-tools">
<div class="dropdown">
<a href="" title="" id="quarto-navigation-tool-dropdown-0" class="quarto-navigation-tool dropdown-toggle px-1" data-bs-toggle="dropdown" aria-expanded="false" role="link" aria-label=""><i class="bi bi-github"></i></a>
<ul class="dropdown-menu" aria-labelledby="quarto-navigation-tool-dropdown-0">
<li>
<a class="dropdown-item quarto-navbar-tools-item" href="https://github.com/ibis-project/ibis">
Source code
</a>
</li>
<li>
<a class="dropdown-item quarto-navbar-tools-item" href="https://github.com/ibis-project/ibis/issues/new?assignees=&labels=bug&projects=&template=bug-report.yml&title=bug">
Report a bug
</a>
</li>
<li>
<a class="dropdown-item quarto-navbar-tools-item" href="https://github.com/ibis-project/ibis/issues/new?assignees=&labels=docs&projects=&template=docs-issue.yml&title=docs">
Report a documentation issue
</a>
</li>
<li>
<a class="dropdown-item quarto-navbar-tools-item" href="https://github.com/ibis-project/ibis/issues/new?assignees=&labels=feature&projects=&template=feature-request.yml&title=feat">
Submit a feature request
</a>
</li>
<li>
<a class="dropdown-item quarto-navbar-tools-item" href="https://github.com/ibis-project/ibis/discussions/new?category=q-a">
Ask the community for help
</a>
</li>
</ul>
</div>
<a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
</div>
</div> <!-- /container-fluid -->
</nav>
<nav class="quarto-secondary-nav">
<div class="container-fluid d-flex">
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href='/tutorials/ibis-for-sql-users'>Tutorial: Ibis for SQL users</a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
</div>
</nav>
</header>
<!-- content -->
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
<!-- sidebar -->
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation floating overflow-auto">
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/install'>
<span class="menu-text">Installation</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/getting_started'>
<span class="menu-text">Tutorial: getting started</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/ibis-for-dplyr-users'>
<span class="menu-text">Tutorial: Ibis for dplyr users</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/ibis-for-pandas-users'>
<span class="menu-text">Tutorial: Ibis for pandas users</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link active' href='/tutorials/ibis-for-sql-users'>
<span class="menu-text">Tutorial: Ibis for SQL users</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Browser</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/browser/repl'>
<span class="menu-text">JupyterLite console</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Cloud Data Platforms</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/cloud-data-platforms/clickhouse'>
<span class="menu-text">ClickHouse</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="false">
<span class="menu-text">Starburst Galaxy</span></a>
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="false" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth2 ">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/cloud-data-platforms/starburst-galaxy/0_setup'>
<span class="menu-text">Requirements and setup</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/cloud-data-platforms/starburst-galaxy/1_basics'>
<span class="menu-text">Basic operations</span></a>
</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true">
<span class="menu-text">Open Source Software</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="false">
<span class="menu-text">Apache Flink</span></a>
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="false" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-5" class="collapse list-unstyled sidebar-section depth2 ">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/open-source-software/apache-flink/0_setup'>
<span class="menu-text">Getting started</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a class='sidebar-item-text sidebar-link' href='/tutorials/open-source-software/apache-flink/1_single_feature'>
<span class="menu-text">A real-life use case: fraud detection</span></a>
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</nav>
<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">On this page</h2>
<ul>
<li><a href="#prerequisites" id="toc-prerequisites" class="nav-link active" data-scroll-target="#prerequisites">Prerequisites</a></li>
<li><a href="#overview" id="toc-overview" class="nav-link" data-scroll-target="#overview">Overview</a></li>
<li><a href="#projections-selectaddremove-columns" id="toc-projections-selectaddremove-columns" class="nav-link" data-scroll-target="#projections-selectaddremove-columns">Projections: select/add/remove columns</a>
<ul class="collapse">
<li><a href="#mutate-add-or-modify-columns-easily" id="toc-mutate-add-or-modify-columns-easily" class="nav-link" data-scroll-target="#mutate-add-or-modify-columns-easily"><code>mutate</code>: Add or modify columns easily</a></li>
<li><a href="#select-equivalent" id="toc-select-equivalent" class="nav-link" data-scroll-target="#select-equivalent"><code>SELECT *</code> equivalent</a></li>
<li><a href="#using-functions-in-projections" id="toc-using-functions-in-projections" class="nav-link" data-scroll-target="#using-functions-in-projections">Using functions in projections</a></li>
</ul></li>
<li><a href="#filtering-where" id="toc-filtering-where" class="nav-link" data-scroll-target="#filtering-where">Filtering / <code>WHERE</code></a></li>
<li><a href="#aggregation-group-by" id="toc-aggregation-group-by" class="nav-link" data-scroll-target="#aggregation-group-by">Aggregation / <code>GROUP BY</code></a>
<ul class="collapse">
<li><a href="#non-trivial-grouping-keys" id="toc-non-trivial-grouping-keys" class="nav-link" data-scroll-target="#non-trivial-grouping-keys">Non-trivial grouping keys</a></li>
<li><a href="#aggregates-considering-table-subsets" id="toc-aggregates-considering-table-subsets" class="nav-link" data-scroll-target="#aggregates-considering-table-subsets">Aggregates considering table subsets</a></li>
<li><a href="#counting-rows-with-table.count" id="toc-counting-rows-with-table.count" class="nav-link" data-scroll-target="#counting-rows-with-table.count">Counting rows with <code>Table.count()</code>:</a></li>
<li><a href="#frequency-table-convenience-value_counts" id="toc-frequency-table-convenience-value_counts" class="nav-link" data-scroll-target="#frequency-table-convenience-value_counts">Frequency table convenience: <code>value_counts</code></a></li>
<li><a href="#having-clause" id="toc-having-clause" class="nav-link" data-scroll-target="#having-clause"><code>HAVING</code> clause</a></li>
</ul></li>
<li><a href="#sorting-order-by" id="toc-sorting-order-by" class="nav-link" data-scroll-target="#sorting-order-by">Sorting / <code>ORDER BY</code></a></li>
<li><a href="#limit-and-offset" id="toc-limit-and-offset" class="nav-link" data-scroll-target="#limit-and-offset"><code>LIMIT</code> and <code>OFFSET</code></a></li>
<li><a href="#common-column-expressions" id="toc-common-column-expressions" class="nav-link" data-scroll-target="#common-column-expressions">Common column expressions</a>
<ul class="collapse">
<li><a href="#type-casts" id="toc-type-casts" class="nav-link" data-scroll-target="#type-casts">Type casts</a></li>
<li><a href="#case-statements" id="toc-case-statements" class="nav-link" data-scroll-target="#case-statements"><code>CASE</code> statements</a></li>
<li><a href="#using-null-in-expressions" id="toc-using-null-in-expressions" class="nav-link" data-scroll-target="#using-null-in-expressions">Using <code>NULL</code> in expressions</a></li>
<li><a href="#set-membership-in-not-in" id="toc-set-membership-in-not-in" class="nav-link" data-scroll-target="#set-membership-in-not-in">Set membership: <code>IN</code> / <code>NOT IN</code></a></li>
<li><a href="#constant-and-literal-expressions" id="toc-constant-and-literal-expressions" class="nav-link" data-scroll-target="#constant-and-literal-expressions">Constant and literal expressions</a></li>
<li><a href="#is-null-and-is-not-null" id="toc-is-null-and-is-not-null" class="nav-link" data-scroll-target="#is-null-and-is-not-null"><code>IS NULL</code> and <code>IS NOT NULL</code></a></li>
<li><a href="#between" id="toc-between" class="nav-link" data-scroll-target="#between"><code>BETWEEN</code></a></li>
</ul></li>
<li><a href="#joins" id="toc-joins" class="nav-link" data-scroll-target="#joins">Joins</a>
<ul class="collapse">
<li><a href="#join-projection" id="toc-join-projection" class="nav-link" data-scroll-target="#join-projection">Join + projection</a></li>
<li><a href="#join-aggregation" id="toc-join-aggregation" class="nav-link" data-scroll-target="#join-aggregation">Join + aggregation</a></li>
<li><a href="#join-with-select" id="toc-join-with-select" class="nav-link" data-scroll-target="#join-with-select">Join with <code>SELECT *</code></a></li>
<li><a href="#multiple-joins" id="toc-multiple-joins" class="nav-link" data-scroll-target="#multiple-joins">Multiple joins</a></li>
<li><a href="#self-joins" id="toc-self-joins" class="nav-link" data-scroll-target="#self-joins">Self joins</a></li>
<li><a href="#overlapping-join-keys" id="toc-overlapping-join-keys" class="nav-link" data-scroll-target="#overlapping-join-keys">Overlapping join keys</a></li>
<li><a href="#non-equality-join-predicates" id="toc-non-equality-join-predicates" class="nav-link" data-scroll-target="#non-equality-join-predicates">Non-equality join predicates</a></li>
<li><a href="#other-ways-to-specify-join-keys" id="toc-other-ways-to-specify-join-keys" class="nav-link" data-scroll-target="#other-ways-to-specify-join-keys">Other ways to specify join keys</a></li>
</ul></li>
<li><a href="#subqueries" id="toc-subqueries" class="nav-link" data-scroll-target="#subqueries">Subqueries</a>
<ul class="collapse">
<li><a href="#correlated-exists-not-exists-filters" id="toc-correlated-exists-not-exists-filters" class="nav-link" data-scroll-target="#correlated-exists-not-exists-filters">Correlated <code>EXISTS</code> / <code>NOT EXISTS</code> filters</a></li>
<li><a href="#subqueries-with-in-not-in" id="toc-subqueries-with-in-not-in" class="nav-link" data-scroll-target="#subqueries-with-in-not-in">Subqueries with <code>IN</code> / <code>NOT IN</code></a></li>
<li><a href="#comparison-with-scalar-aggregates" id="toc-comparison-with-scalar-aggregates" class="nav-link" data-scroll-target="#comparison-with-scalar-aggregates">Comparison with scalar aggregates</a></li>
<li><a href="#conditional-aggregates" id="toc-conditional-aggregates" class="nav-link" data-scroll-target="#conditional-aggregates">Conditional aggregates</a></li>
</ul></li>
<li><a href="#distinct-expressions" id="toc-distinct-expressions" class="nav-link" data-scroll-target="#distinct-expressions"><code>DISTINCT</code> expressions</a></li>
<li><a href="#window-functions" id="toc-window-functions" class="nav-link" data-scroll-target="#window-functions">Window functions</a></li>
<li><a href="#top-k-operations" id="toc-top-k-operations" class="nav-link" data-scroll-target="#top-k-operations">Top-K operations</a></li>
<li><a href="#date-time-data" id="toc-date-time-data" class="nav-link" data-scroll-target="#date-time-data">Date / time data</a>
<ul class="collapse">
<li><a href="#casting-to-date-time-types" id="toc-casting-to-date-time-types" class="nav-link" data-scroll-target="#casting-to-date-time-types">Casting to date / time types</a></li>
<li><a href="#intervals" id="toc-intervals" class="nav-link" data-scroll-target="#intervals">Intervals</a></li>
</ul></li>
<li><a href="#buckets-and-histograms" id="toc-buckets-and-histograms" class="nav-link" data-scroll-target="#buckets-and-histograms">Buckets and histograms</a></li>
<li><a href="#unions" id="toc-unions" class="nav-link" data-scroll-target="#unions">Unions</a></li>
<li><a href="#esoterica" id="toc-esoterica" class="nav-link" data-scroll-target="#esoterica">Esoterica</a>
<ul class="collapse">
<li><a href="#common-table-expressions-ctes" id="toc-common-table-expressions-ctes" class="nav-link" data-scroll-target="#common-table-expressions-ctes">Common table expressions (CTEs)</a></li>
</ul></li>
</ul>
<div class="toc-actions"><ul><li><a href="https://github.com/ibis-project/ibis/edit/main/docs/tutorials/ibis-for-sql-users.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/ibis-project/ibis/issues/new/choose" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
</div>
<!-- main -->
<main class="content" id="quarto-document-content">
<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title">Tutorial: Ibis for SQL users</h1>
</div>
<div class="quarto-title-meta">
</div>
</header>
<section id="prerequisites" class="level2">
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<p>We recommend starting with the default (DuckDB) backend for a performant, fully-featured local experience. You can install Ibis with <code>pip</code>, <code>conda</code>, <code>mamba</code>, or <code>pixi</code>.</p>
<div class="tabset-margin-container"></div><div class="panel-tabset">
<ul class="nav nav-tabs" role="tablist"><li class="nav-item" role="presentation"><a class="nav-link active" id="tabset-1-1-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-1" role="tab" aria-controls="tabset-1-1" aria-selected="true" aria-current="page">Using <code>pip</code></a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-2-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-2" role="tab" aria-controls="tabset-1-2" aria-selected="false">Using <code>conda</code></a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-3-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-3" role="tab" aria-controls="tabset-1-3" aria-selected="false">Using <code>mamba</code></a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-4-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-4" role="tab" aria-controls="tabset-1-4" aria-selected="false">Using <code>pixi</code></a></li></ul>
<div class="tab-content">
<div id="tabset-1-1" class="tab-pane active" role="tabpanel" aria-labelledby="tabset-1-1-tab">
<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install <span class="st">'ibis-framework[duckdb,examples]'</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="callout callout-style-default callout-warning callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Warning
</div>
</div>
<div class="callout-body-container callout-body">
<p>Note that the <code>ibis-framework</code> package is <em>not</em> the same as the <code>ibis</code> package in PyPI. These two libraries cannot coexist in the same Python environment, as they are both imported with the <code>ibis</code> module name.</p>
</div>
</div>
</div>
<div id="tabset-1-2" class="tab-pane" role="tabpanel" aria-labelledby="tabset-1-2-tab">
<div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">conda</span> install <span class="at">-c</span> conda-forge ibis-duckdb</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<div id="tabset-1-3" class="tab-pane" role="tabpanel" aria-labelledby="tabset-1-3-tab">
<div class="sourceCode" id="cb3"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">mamba</span> install <span class="at">-c</span> conda-forge ibis-duckdb</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<div id="tabset-1-4" class="tab-pane" role="tabpanel" aria-labelledby="tabset-1-4-tab">
<div class="sourceCode" id="cb4"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pixi</span> add ibis-duckdb</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
</div>
</section>
<section id="overview" class="level2">
<h2 class="anchored" data-anchor-id="overview">Overview</h2>
<p>Ibis provides a full-featured replacement for SQL <code>SELECT</code> queries, but expressed with Python code that is:</p>
<ul>
<li>Type-checked and validated as you go. No more debugging cryptic database errors; Ibis catches your mistakes right away.</li>
<li>Easier to write. Pythonic function calls with tab completion in IPython.</li>
<li>More composable. Break complex queries down into easier-to-digest pieces</li>
<li>Easier to reuse. Mix and match Ibis snippets to create expressions tailored for your analysis.</li>
</ul>
<p>We intend for all <code>SELECT</code> queries to be fully portable to Ibis. Coverage of other DDL statements (e.g. <code>CREATE TABLE</code> or <code>INSERT</code>) may vary from engine to engine.</p>
<div class="callout callout-style-default callout-note callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Note
</div>
</div>
<div class="callout-body-container callout-body">
<p>If you find any SQL idioms or use cases in your work that are not represented here, please reach out so we can add more to this guide!</p>
</div>
</div>
</section>
<section id="projections-selectaddremove-columns" class="level2">
<h2 class="anchored" data-anchor-id="projections-selectaddremove-columns">Projections: select/add/remove columns</h2>
<p>All tables in Ibis are immutable. To select a subset of a table’s columns, or to add new columns, you must produce a new table by means of a <em>projection</em>.</p>
<div id="f9b82c74" class="cell" data-execution_count="1">
<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> ibis</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a>t <span class="op">=</span> ibis.table(<span class="bu">dict</span>(one<span class="op">=</span><span class="st">"string"</span>, two<span class="op">=</span><span class="st">"float"</span>, three<span class="op">=</span><span class="st">"int32"</span>), name<span class="op">=</span><span class="st">"my_data"</span>)</span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a>t</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="1">
<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">UnboundTable: my_data
one string
two float64
three int32
</pre>
</div>
</div>
<p>In SQL, you might write something like:</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span> two, one</span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> my_data</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>In Ibis, this is</p>
<div id="f8757cf3" class="cell" data-execution_count="2">
<div class="sourceCode cell-code" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>proj <span class="op">=</span> t[<span class="st">"two"</span>, <span class="st">"one"</span>]</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<p>or</p>
<div id="8ff697fb" class="cell" data-execution_count="3">
<div class="sourceCode cell-code" id="cb8"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>proj <span class="op">=</span> t.select(<span class="st">"two"</span>, <span class="st">"one"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<p>This generates the expected SQL:</p>
<div id="cccdee10" class="cell" data-execution_count="4">
<div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>ibis.to_sql(proj)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display cell-output-markdown" data-execution_count="4">
<div class="sourceCode" id="cb10"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span></span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"two"</span>,</span>
<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"one"</span></span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> <span class="ot">"my_data"</span> <span class="kw">AS</span> <span class="ot">"t0"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
<p>What about adding new columns?</p>
<div class="sourceCode" id="cb11"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span> two, one, three <span class="op">*</span> <span class="dv">2</span> <span class="kw">AS</span> new_col</span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> my_data</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>The last expression is written:</p>
<div id="31c275e7" class="cell" data-execution_count="5">
<div class="sourceCode cell-code" id="cb12"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a>new_col <span class="op">=</span> (t.three <span class="op">*</span> <span class="dv">2</span>).name(<span class="st">"new_col"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<p>Now, we have:</p>
<div id="ff39d368" class="cell" data-execution_count="6">
<div class="sourceCode cell-code" id="cb13"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a>proj <span class="op">=</span> t[<span class="st">"two"</span>, <span class="st">"one"</span>, new_col]</span>
<span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a>ibis.to_sql(proj)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display cell-output-markdown" data-execution_count="6">
<div class="sourceCode" id="cb14"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span></span>
<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"two"</span>,</span>
<span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"one"</span>,</span>
<span id="cb14-4"><a href="#cb14-4" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"three"</span> <span class="op">*</span> <span class="dv">2</span> <span class="kw">AS</span> <span class="ot">"new_col"</span></span>
<span id="cb14-5"><a href="#cb14-5" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> <span class="ot">"my_data"</span> <span class="kw">AS</span> <span class="ot">"t0"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
<section id="mutate-add-or-modify-columns-easily" class="level3">
<h3 class="anchored" data-anchor-id="mutate-add-or-modify-columns-easily"><code>mutate</code>: Add or modify columns easily</h3>
<p>Since adding new columns or modifying existing columns is so common, there is a convenience method <code>mutate</code>:</p>
<div id="bd091287" class="cell" data-execution_count="7">
<div class="sourceCode cell-code" id="cb15"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>mutated <span class="op">=</span> t.mutate(new_col<span class="op">=</span>t.three <span class="op">*</span> <span class="dv">2</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<p>Notice that using the <code>name</code> was not necessary here because we’re using Python keyword arguments to provide the name:</p>
<div id="ae70bca6" class="cell" data-execution_count="8">
<div class="sourceCode cell-code" id="cb16"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>ibis.to_sql(mutated)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display cell-output-markdown" data-execution_count="8">
<div class="sourceCode" id="cb17"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span></span>
<span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"one"</span>,</span>
<span id="cb17-3"><a href="#cb17-3" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"two"</span>,</span>
<span id="cb17-4"><a href="#cb17-4" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"three"</span>,</span>
<span id="cb17-5"><a href="#cb17-5" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"three"</span> <span class="op">*</span> <span class="dv">2</span> <span class="kw">AS</span> <span class="ot">"new_col"</span></span>
<span id="cb17-6"><a href="#cb17-6" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> <span class="ot">"my_data"</span> <span class="kw">AS</span> <span class="ot">"t0"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
<p>If you modify an existing column with <code>mutate</code> it will list out all the other columns:</p>
<div id="c8efdf0e" class="cell" data-execution_count="9">
<div class="sourceCode cell-code" id="cb18"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>mutated <span class="op">=</span> t.mutate(two<span class="op">=</span>t.two <span class="op">*</span> <span class="dv">2</span>)</span>
<span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a>ibis.to_sql(mutated)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display cell-output-markdown" data-execution_count="9">
<div class="sourceCode" id="cb19"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span></span>
<span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"one"</span>,</span>
<span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"two"</span> <span class="op">*</span> <span class="dv">2</span> <span class="kw">AS</span> <span class="ot">"two"</span>,</span>
<span id="cb19-4"><a href="#cb19-4" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"three"</span></span>
<span id="cb19-5"><a href="#cb19-5" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> <span class="ot">"my_data"</span> <span class="kw">AS</span> <span class="ot">"t0"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
</section>
<section id="select-equivalent" class="level3">
<h3 class="anchored" data-anchor-id="select-equivalent"><code>SELECT *</code> equivalent</h3>
<p>Especially in combination with relational joins, it’s convenient to be able to select all columns in a table using the <code>SELECT *</code> construct. To do this, use the table expression itself in a projection:</p>
<div id="8b5efed2" class="cell" data-execution_count="10">
<div class="sourceCode cell-code" id="cb20"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a>proj <span class="op">=</span> t[t]</span>
<span id="cb20-2"><a href="#cb20-2" aria-hidden="true" tabindex="-1"></a>ibis.to_sql(proj)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display cell-output-markdown" data-execution_count="10">
<div class="sourceCode" id="cb21"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span></span>
<span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a> <span class="op">*</span></span>
<span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a><span class="kw">FROM</span> <span class="ot">"my_data"</span> <span class="kw">AS</span> <span class="ot">"t0"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
<p>This is how <code>mutate</code> is implemented. The example above <code>t.mutate(new_col=t.three * 2)</code> can be written as a normal projection:</p>
<div id="c630707d" class="cell" data-execution_count="11">
<div class="sourceCode cell-code" id="cb22"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a>proj <span class="op">=</span> t[t, new_col]</span>
<span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a>ibis.to_sql(proj)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display cell-output-markdown" data-execution_count="11">
<div class="sourceCode" id="cb23"><pre class="sourceCode sql code-with-copy"><code class="sourceCode sql"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a><span class="kw">SELECT</span></span>
<span id="cb23-2"><a href="#cb23-2" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"one"</span>,</span>
<span id="cb23-3"><a href="#cb23-3" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"two"</span>,</span>
<span id="cb23-4"><a href="#cb23-4" aria-hidden="true" tabindex="-1"></a> <span class="ot">"t0"</span>.<span class="ot">"three"</span>,</span>