From a47c5cc718a36af4d3eb01464cd6b7ded5bf3b2e Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Mon, 9 Dec 2024 19:44:19 +0000 Subject: [PATCH] build based on 9fd9317 --- latest/reference/index.html | 340 ++++++++++++++++++------------------ 1 file changed, 170 insertions(+), 170 deletions(-) diff --git a/latest/reference/index.html b/latest/reference/index.html index 4b82d5f..fa46662 100644 --- a/latest/reference/index.html +++ b/latest/reference/index.html @@ -764,34 +764,34 @@

Reference - Exported functions
# Connect to MySQL
-# conn = connect(mysql(); host="localhost", user="root", password="password", db="mydb")
-# Connect to PostgreSQL using LibPQ
-# conn = connect(postgres(); host="localhost", dbname="mydb", user="postgres", password="password")
-# Connect to ClickHouse
-# conn = connect(clickhouse(); host="localhost", port=9000, database="mydb", user="default", password="")
-# Connect to SQLite
-# conn = connect(sqlite())
-# Connect to Google Big Query
-# conn = connect(gbq(), "json_user_key_path", "location")
-# Connect to Snowflake
-# conn = connect(snowflake(), "ac_id", "token", "Database_name", "Schema_name", "warehouse_name")
-# Connect to Microsoft SQL Server
-# conn = connect(mssql(), "DRIVER={ODBC Driver 18 for SQL Server};SERVER=host,1433;UID=sa;PWD=YourPassword;Encrypt=no;TrustServerCertificate=yes")
-# Connect to DuckDB
-# connect to Google Cloud via DuckDB
-# google_db = connect(duckdb(), :gbq, access_key="string", secret_key="string")
-# Connect to AWS via DuckDB
-# aws_db = connect2(duckdb(), :aws, aws_access_key_id=get(ENV, "AWS_ACCESS_KEY_ID", "access_key"), aws_secret_access_key=get(ENV, "AWS_SECRET_ACCESS_KEY", "secret_access key"), aws_region=get(ENV, "AWS_DEFAULT_REGION", "us-east-1"))
-# Connect to MotherDuck
-# connect(duckdb(), ""md://..."") for first connection, vs connect(duckdb(), "md:") for reconnection
-# Connect to exisiting database file
-# connect(duckdb(), "path/to/database.duckdb")
-# Open an in-memory database
-julia> db = connect(duckdb())
-DuckDB.Connection(":memory:")
-
-

source

+
# Connect to MySQL
+# conn = connect(mysql(); host="localhost", user="root", password="password", db="mydb")
+# Connect to PostgreSQL using LibPQ
+# conn = connect(postgres(); host="localhost", dbname="mydb", user="postgres", password="password")
+# Connect to ClickHouse
+# conn = connect(clickhouse(); host="localhost", port=9000, database="mydb", user="default", password="")
+# Connect to SQLite
+# conn = connect(sqlite())
+# Connect to Google Big Query
+# conn = connect(gbq(), "json_user_key_path", "location")
+# Connect to Snowflake
+# conn = connect(snowflake(), "ac_id", "token", "Database_name", "Schema_name", "warehouse_name")
+# Connect to Microsoft SQL Server
+# conn = connect(mssql(), "DRIVER={ODBC Driver 18 for SQL Server};SERVER=host,1433;UID=sa;PWD=YourPassword;Encrypt=no;TrustServerCertificate=yes")
+# Connect to DuckDB
+# connect to Google Cloud via DuckDB
+# google_db = connect(duckdb(), :gbq, access_key="string", secret_key="string")
+# Connect to AWS via DuckDB
+# aws_db = connect2(duckdb(), :aws, aws_access_key_id=get(ENV, "AWS_ACCESS_KEY_ID", "access_key"), aws_secret_access_key=get(ENV, "AWS_SECRET_ACCESS_KEY", "secret_access key"), aws_region=get(ENV, "AWS_DEFAULT_REGION", "us-east-1"))
+# Connect to MotherDuck
+# connect(duckdb(), ""md://..."") for first connection, vs connect(duckdb(), "md:") for reconnection
+# Connect to exisiting database file
+# connect(duckdb(), "path/to/database.duckdb")
+# Open an in-memory database
+julia> db = connect(duckdb())
+DuckDB.Connection(":memory:")
+
+

source

# TidierDB.copy_to — Method.

   copy_to(conn, df_or_path, "name")
@@ -809,7 +809,7 @@ 
Reference - Exported functionsjulia> copy_to(db, df, "test");
-

source

+

source

# TidierDB.db_table — Function.

db_table(database, table_name, athena_params, delta = false, iceberg = false)
@@ -849,7 +849,7 @@ 
Reference - Exported functions   3 │ value    BIGINT               1  df_mem
    4 │ percent  DOUBLE               1  df_mem, false, DuckDB.Connection(":memory:"), TidierDB.CTE[], 0, nothing)
-

source

+

source

# TidierDB.show_tables — Method.

show_tables(con; GBQ_datasetname)
@@ -865,7 +865,7 @@ 
Reference - Exported functionsjulia> show_tables(db);
-

source

+

source

# TidierDB.warnings — Method.

warnings(show::Bool)
@@ -880,7 +880,7 @@ 
Reference - Exported functions
julia> warnings(true);
-

source

+

source

# TidierDB.@anti_join — Macro.

@anti_join(sql_query, join_table, orignal_table_col = new_table_col)
@@ -923,7 +923,7 @@ 
Reference - Exported functions   4 │ AH      aa          3      0.8
    5 │ AJ      aa          5      1.0
-

source

+

source

# TidierDB.@arrange — Macro.

@arrange(sql_query, columns...)
@@ -963,7 +963,7 @@ 
Reference - Exported functions   9 │ AJ      aa          5      1.0
   10 │ AE      bb          5      0.5
-

source

+

source

# TidierDB.@collect — Macro.

@collect(sql_query, stream = false)
@@ -1000,7 +1000,7 @@ 
Reference - Exported functions   9 │ AI      bb          4      0.9
   10 │ AJ      aa          5      1.0
-

source

+

source

# TidierDB.@count — Macro.

@count(sql_query, columns...)
@@ -1033,7 +1033,7 @@ 
Reference - Exported functions   1 │ aa          5
    2 │ bb          5
-

source

+

source

# TidierDB.@create_view — Macro.

@view(sql_query, name, replace = true)
@@ -1046,23 +1046,23 @@ 
Reference - Exported functions
julia> db = connect(duckdb());
+
julia> db = connect(duckdb());
 
-julia> df = DataFrame(id = [1, 2, 3], value = [10, 20, 30]);
+julia> df = DataFrame(id = [1, 2, 3], value = [10, 20, 30]);
 
-julia> copy_to(db, df, "df1");
+julia> copy_to(db, df, "df1");
 
-julia> @chain db_table(db, "df1") @create_view(viewer);
+julia> @chain db_table(db, "df1") @create_view(viewer);
 
-julia> db_table(db, "viewer")
-TidierDB.SQLQuery("", "viewer", "", "", "", "", "", "", false, false, 2×4 DataFrame
- Row │ name    type    current_selxn  table_name 
-     │ String  String  Int64          String     
-─────┼───────────────────────────────────────────
-   1 │ id      BIGINT              1  viewer
-   2 │ value   BIGINT              1  viewer, false, DuckDB.DB(":memory:"), TidierDB.CTE[], 0, nothing, "", "", 0)
+julia> db_table(db, "viewer")
+TidierDB.SQLQuery("", "viewer", "", "", "", "", "", "", false, false, 2×4 DataFrame
+ Row │ name    type    current_selxn  table_name 
+     │ String  String  Int64          String     
+─────┼───────────────────────────────────────────
+   1 │ id      BIGINT              1  viewer
+   2 │ value   BIGINT              1  viewer, false, DuckDB.DB(":memory:"), TidierDB.CTE[], 0, nothing, "", "", 0)
 

-
source

+
source

 
#
 TidierDB.@distinct — Macro.

 
@distinct(sql_query, columns...)
@@ -1115,7 +1115,7 @@ 
Reference - Exported functions   9 │ AI      bb          4      0.9
   10 │ AJ      aa          5      1.0
 

-
source

+
source

 
#
 TidierDB.@filter — Macro.

 
@filter(sql_query, conditions...)
@@ -1171,7 +1171,7 @@ 
Reference - Exported functions   1 │ aa          0.6
    2 │ bb          0.5
 

-
source

+
source

 
#
 TidierDB.@full_join — Macro.

 
@inner_join(sql_query, join_table, orignal_table_col = new_table_col)
@@ -1221,7 +1221,7 @@ 
Reference - Exported functions  10 │ AJ       aa             5        1.0  missing  missing   missing 
   11 │ missing  missing  missing  missing    AM       X              74
 

-
source

+
source

 
#
 TidierDB.@group_by — Macro.

 
@group_by(sql_query, columns...)
@@ -1254,7 +1254,7 @@ 
Reference - Exported functions   1 │ aa
    2 │ bb
 

-
source

+
source

 
#
 TidierDB.@head — Macro.

 
@head(sql_query, value)
@@ -1285,7 +1285,7 @@ 
Reference - Exported functions─────┼────────────────────────────────
    1 │ AA      bb          1      0.1
 

-
source

+
source

 
#
 TidierDB.@inner_join — Macro.

 
@inner_join(sql_query, join_table, orignal_table_col = new_table_col)
@@ -1328,7 +1328,7 @@ 
Reference - Exported functions   4 │ AG      bb          2      0.7  AG      Y            83
    5 │ AI      bb          4      0.9  AI      X            95
 

-
source

+
source

 
#
 TidierDB.@left_join — Macro.

 
@left_join(sql_query, join_table, orignal_table_col = new_table_col)
@@ -1399,7 +1399,7 @@ 
Reference - Exported functions   9 │ AH      aa          3      0.8  missing  missing   missing 
   10 │ AJ      aa          5      1.0  missing  missing   missing 
 

-
source

+
source

 
#
 TidierDB.@mutate — Macro.

 
@mutate(sql_query, exprs...; _by, _frame, _order)
@@ -1487,7 +1487,7 @@ 
Reference - Exported functions   9 │ AC      bb          3      0.3       9        1
   10 │ AA      bb          1      0.1       4  missing 
 

-
source

+
source

 
#
 TidierDB.@relocate — Macro.

 
@relocate(sql_query, columns, before = nothing, after = nothing)
@@ -1500,54 +1500,54 @@ 
Reference - Exported functions
julia> df = DataFrame(id = [string('A' + i ÷ 26, 'A' + i % 26) for i in 0:9], 
-                        groups = [i % 2 == 0 ? "aa" : "bb" for i in 1:10], 
-                        value = repeat(1:5, 2), 
-                        percent = 0.1:0.1:1.0);
-
-julia> db = connect(duckdb());
-
-julia> copy_to(db, df, "df_mem");
-
-julia> @chain db_table(db, :df_mem) begin 
-        @relocate(groups, value, ends_with("d"), after = percent) 
-        @collect
-       end
-10×4 DataFrame
- Row │ percent  groups  value  id     
-     │ Float64  String  Int64  String 
-─────┼────────────────────────────────
-   1 │     0.1  bb          1  AA
-   2 │     0.2  aa          2  AB
-   3 │     0.3  bb          3  AC
-   4 │     0.4  aa          4  AD
-   5 │     0.5  bb          5  AE
-   6 │     0.6  aa          1  AF
-   7 │     0.7  bb          2  AG
-   8 │     0.8  aa          3  AH
-   9 │     0.9  bb          4  AI
-  10 │     1.0  aa          5  AJ
-
-julia> @chain db_table(db, :df_mem) begin 
-        @relocate([:percent, :groups], before = id) 
-        @collect
-       end
-10×4 DataFrame
- Row │ percent  groups  id      value 
-     │ Float64  String  String  Int64 
-─────┼────────────────────────────────
-   1 │     0.1  bb      AA          1
-   2 │     0.2  aa      AB          2
-   3 │     0.3  bb      AC          3
-   4 │     0.4  aa      AD          4
-   5 │     0.5  bb      AE          5
-   6 │     0.6  aa      AF          1
-   7 │     0.7  bb      AG          2
-   8 │     0.8  aa      AH          3
-   9 │     0.9  bb      AI          4
-  10 │     1.0  aa      AJ          5
-

-
source

+
julia> df = DataFrame(id = [string('A' + i ÷ 26, 'A' + i % 26) for i in 0:9], 
+                        groups = [i % 2 == 0 ? "aa" : "bb" for i in 1:10], 
+                        value = repeat(1:5, 2), 
+                        percent = 0.1:0.1:1.0);
+
+julia> db = connect(duckdb());
+
+julia> copy_to(db, df, "df_mem");
+
+julia> @chain db_table(db, :df_mem) begin 
+        @relocate(groups, value, ends_with("d"), after = percent) 
+        @collect
+       end
+10×4 DataFrame
+ Row │ percent  groups  value  id     
+     │ Float64  String  Int64  String 
+─────┼────────────────────────────────
+   1 │     0.1  bb          1  AA
+   2 │     0.2  aa          2  AB
+   3 │     0.3  bb          3  AC
+   4 │     0.4  aa          4  AD
+   5 │     0.5  bb          5  AE
+   6 │     0.6  aa          1  AF
+   7 │     0.7  bb          2  AG
+   8 │     0.8  aa          3  AH
+   9 │     0.9  bb          4  AI
+  10 │     1.0  aa          5  AJ
+
+julia> @chain db_table(db, :df_mem) begin 
+        @relocate([:percent, :groups], before = id) 
+        @collect
+       end
+10×4 DataFrame
+ Row │ percent  groups  id      value 
+     │ Float64  String  String  Int64 
+─────┼────────────────────────────────
+   1 │     0.1  bb      AA          1
+   2 │     0.2  aa      AB          2
+   3 │     0.3  bb      AC          3
+   4 │     0.4  aa      AD          4
+   5 │     0.5  bb      AE          5
+   6 │     0.6  aa      AF          1
+   7 │     0.7  bb      AG          2
+   8 │     0.8  aa      AH          3
+   9 │     0.9  bb      AI          4
+  10 │     1.0  aa      AJ          5
+

+
source

 
#
 TidierDB.@rename — Macro.

 
@rename(sql_query, renamings...)
@@ -1584,7 +1584,7 @@ 
Reference - Exported functions   9 │ AI      bb          4       0.9
   10 │ AJ      aa          5       1.0
 

-
source

+
source

 
#
 TidierDB.@right_join — Macro.

 
@right_join(sql_query, join_table, orignal_table_col = new_table_col)
@@ -1648,7 +1648,7 @@ 
Reference - Exported functions   5 │ AI       bb             4        0.9  AI      X            95
    6 │ missing  missing  missing  missing    AM      X            74
 

-
source

+
source

 
#
 TidierDB.@select — Macro.

 
@select(sql_query, columns)
@@ -1709,7 +1709,7 @@ 
Reference - Exported functions   9 │     4      0.9
   10 │     5      1.0
 

-
source

+
source

 
#
 TidierDB.@semi_join — Macro.

 
@semi_join(sql_query, join_table, orignal_table_col = new_table_col)
@@ -1752,7 +1752,7 @@ 
Reference - Exported functions   4 │ AG      bb          2      0.7
    5 │ AI      bb          4      0.9
 

-
source

+
source

 
#
 TidierDB.@slice_max — Macro.

 
@slice_max(sql_query, column, n = 1)
@@ -1791,7 +1791,7 @@ 
Reference - Exported functions   1 │ AE      bb          5      0.5         1
    2 │ AJ      aa          5      1.0         1
 

-
source

+
source

 
#
 TidierDB.@slice_min — Macro.

 
@slice_min(sql_query, column, n = 1)
@@ -1830,7 +1830,7 @@ 
Reference - Exported functions   1 │ AA      bb          1      0.1         1
    2 │ AF      aa          1      0.6         1
 

-
source

+
source

 
#
 TidierDB.@slice_sample — Macro.

 
@slice_sample(sql_query, n)
@@ -1862,7 +1862,7 @@ 
Reference - Exported functions       @collect
        end;
 

-
source

+
source

 
#
 TidierDB.@summarise — Macro.

 
   @summarise(sql_query, exprs...)
@@ -1909,7 +1909,7 @@ 
Reference - Exported functions   1 │ aa          3.0      5
    2 │ bb          2.5      5
 

-
source

+
source

 
#
 TidierDB.@summarize — Macro.

 
   @summarize(sql_query, exprs...; _by)
@@ -1969,7 +1969,7 @@ 
Reference - Exported functions   1 │ aa          3.0      5
    2 │ bb          2.5      5
 

-
source

+
source

 
#
 TidierDB.@union — Macro.

 
@union(sql_query1, sql_query2)
@@ -1985,60 +1985,60 @@ 
Reference - Exported functions
julia> db = connect(duckdb());
+
julia> db = connect(duckdb());
 
-julia> df1 = DataFrame(id = [1, 2, 3], value = [10, 20, 30]);
+julia> df1 = DataFrame(id = [1, 2, 3], value = [10, 20, 30]);
 
-julia> df2 = DataFrame(id = [4, 5, 6], value = [40, 50, 60]);
+julia> df2 = DataFrame(id = [4, 5, 6], value = [40, 50, 60]);
 
-julia> copy_to(db, df1, "df1");
+julia> copy_to(db, df1, "df1");
 
-julia> copy_to(db, df2, "df2");
+julia> copy_to(db, df2, "df2");
 
-julia> df1_table = db_table(db, "df1");
+julia> df1_table = db_table(db, "df1");
 
-julia> df2_table = db_table(db, "df2");
+julia> df2_table = db_table(db, "df2");
 
-julia> @chain t(df1_table) @union(df2_table) @collect
-6×2 DataFrame
- Row │ id     value 
-     │ Int64  Int64 
-─────┼──────────────
-   1 │     1     10
-   2 │     2     20
-   3 │     3     30
-   4 │     4     40
-   5 │     5     50
-   6 │     6     60
+julia> @chain t(df1_table) @union(df2_table) @collect
+6×2 DataFrame
+ Row │ id     value 
+     │ Int64  Int64 
+─────┼──────────────
+   1 │     1     10
+   2 │     2     20
+   3 │     3     30
+   4 │     4     40
+   5 │     5     50
+   6 │     6     60
 
-julia> query = @chain t(df2_table) @filter(value == 50);
+julia> query = @chain t(df2_table) @filter(value == 50);
 
-julia> @chain t(df1_table) begin 
+julia> @chain t(df1_table) begin 
         @union(t(query))
         @collect
        end
-4×2 DataFrame
- Row │ id     value 
-     │ Int64  Int64 
-─────┼──────────────
-   1 │     1     10
-   2 │     2     20
-   3 │     3     30
-   4 │     5     50
-
-julia> @chain t(df1_table) begin 
+4×2 DataFrame
+ Row │ id     value 
+     │ Int64  Int64 
+─────┼──────────────
+   1 │     1     10
+   2 │     2     20
+   3 │     3     30
+   4 │     5     50
+
+julia> @chain t(df1_table) begin 
         @union(t(df1_table))
         @collect
        end
-3×2 DataFrame
- Row │ id     value 
-     │ Int64  Int64 
-─────┼──────────────
-   1 │     1     10
-   2 │     2     20
-   3 │     3     30
-

-
source

+3×2 DataFrame
+ Row │ id     value 
+     │ Int64  Int64 
+─────┼──────────────
+   1 │     1     10
+   2 │     2     20
+   3 │     3     30
+

+
source

 
#
 TidierDB.@window_frame — Macro.

 
@window_frame(sql_query, args...)
@@ -2098,7 +2098,7 @@ 
Reference - Exported functions        #@show_query
        end;
 

-
source

+
source

 
#
 TidierDB.@window_order — Macro.

 
   @window_order(sql_query, columns...)
@@ -2127,7 +2127,7 @@ 
Reference - Exported functions       #@show_query 
        end;
 

-
source

+
source

 

 

 
Reference - Internal functions¤

@@ -2146,27 +2146,27 @@ 
Reference - Internal functions
julia> db = connect(duckdb());
+
julia> db = connect(duckdb());
 
-julia> df1 = DataFrame(id = [1, 2, 3], value = [10, 20, 30]);
+julia> df1 = DataFrame(id = [1, 2, 3], value = [10, 20, 30]);
 
-julia> copy_to(db, df1, "df1");
+julia> copy_to(db, df1, "df1");
 
-julia> df1_table = db_table(db, "df1");
+julia> df1_table = db_table(db, "df1");
 
-julia> @chain t(df1_table) @union_all(df1_table) @collect
-6×2 DataFrame
- Row │ id     value 
-     │ Int64  Int64 
-─────┼──────────────
-   1 │     1     10
-   2 │     2     20
-   3 │     3     30
-   4 │     1     10
-   5 │     2     20
-   6 │     3     30
+julia> @chain t(df1_table) @union_all(df1_table) @collect
+6×2 DataFrame
+ Row │ id     value 
+     │ Int64  Int64 
+─────┼──────────────
+   1 │     1     10
+   2 │     2     20
+   3 │     3     30
+   4 │     1     10
+   5 │     2     20
+   6 │     3     30
 

-
source

+
source