Packages
based

4.0.0
4.0.1 4.0.0 3.0.1 3.0.0 2.0.0 1.1.0 1.0.0
Database-agnostic types and a composable SQL query builder for Gleam
HexDocs
Current section
Files
Jump to
Readme 7 Versions 1 Dependency Dependants Files Activity
based src based@internal@fmt.erl
Raw
src/based@internal@fmt.erl

-module(based@internal@fmt).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/based/internal/fmt.gleam").
-export([select/1, select_distinct/1, insert/3, update/1, delete/1, from/2, where/2, set/2, on/2, returning/2, group_by/2, having/2, order_by/2, limit/2, offset/2, for_update/1, on_conflict/2, do_nothing/1, do_update/2, inner_join/2, left_join/2, right_join/2, full_join/2, eq/2, not_eq/2, gt/2, lt/2, gt_eq/2, lt_eq/2, like/2, not_like/2, in_/2, is_null/1, is_not_null/1, is_true/1, is_false/1, between/3, 'not'/1, exists/1, and_op/2, or_op/2, any/1, all/1, subquery/1, count/1, sum/1, avg/1, max/1, min/1, with_cte/1, with_recursive/1, cte/2, union/2, union_all/2, enclose/1, alias_as/2, asc/1, desc/1, terminate/1]).

-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.

?MODULEDOC(false).

-file("src/based/internal/fmt.gleam", 14).
?DOC(false).
-spec select(binary()) -> binary().
select(Columns) ->
    <<"SELECT "/utf8, Columns/binary>>.

-file("src/based/internal/fmt.gleam", 18).
?DOC(false).
-spec select_distinct(binary()) -> binary().
select_distinct(Columns) ->
    <<"SELECT DISTINCT "/utf8, Columns/binary>>.

-file("src/based/internal/fmt.gleam", 22).
?DOC(false).
-spec insert(binary(), list(binary()), list(binary())) -> binary().
insert(Table, Columns, Values) ->
    Columns@1 = gleam@string:join(Columns, <<", "/utf8>>),
    Values@1 = gleam@string:join(Values, <<", "/utf8>>),
    <<<<<<<<<<"INSERT INTO "/utf8, Table/binary>>/binary, " ("/utf8>>/binary,
                Columns@1/binary>>/binary,
            ") VALUES "/utf8>>/binary,
        Values@1/binary>>.

-file("src/based/internal/fmt.gleam", 33).
?DOC(false).
-spec update(binary()) -> binary().
update(Table) ->
    <<"UPDATE "/utf8, Table/binary>>.

-file("src/based/internal/fmt.gleam", 37).
?DOC(false).
-spec delete(binary()) -> binary().
delete(Table) ->
    <<"DELETE FROM "/utf8, Table/binary>>.

-file("src/based/internal/fmt.gleam", 41).
?DOC(false).
-spec from(binary(), binary()) -> binary().
from(St, Value) ->
    <<<<St/binary, " FROM "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 45).
?DOC(false).
-spec where(binary(), binary()) -> binary().
where(St, Value) ->
    <<<<St/binary, " WHERE "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 49).
?DOC(false).
-spec set(binary(), binary()) -> binary().
set(St, Assignments) ->
    <<<<St/binary, " SET "/utf8>>/binary, Assignments/binary>>.

-file("src/based/internal/fmt.gleam", 53).
?DOC(false).
-spec on(binary(), binary()) -> binary().
on(St, Value) ->
    <<<<St/binary, " ON "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 57).
?DOC(false).
-spec returning(binary(), binary()) -> binary().
returning(St, Columns) ->
    <<<<St/binary, " RETURNING "/utf8>>/binary, Columns/binary>>.

-file("src/based/internal/fmt.gleam", 61).
?DOC(false).
-spec group_by(binary(), binary()) -> binary().
group_by(St, Columns) ->
    <<<<St/binary, " GROUP BY "/utf8>>/binary, Columns/binary>>.

-file("src/based/internal/fmt.gleam", 65).
?DOC(false).
-spec having(binary(), binary()) -> binary().
having(St, Value) ->
    <<<<St/binary, " HAVING "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 69).
?DOC(false).
-spec order_by(binary(), binary()) -> binary().
order_by(St, Columns) ->
    <<<<St/binary, " ORDER BY "/utf8>>/binary, Columns/binary>>.

-file("src/based/internal/fmt.gleam", 73).
?DOC(false).
-spec limit(binary(), integer()) -> binary().
limit(St, N) ->
    <<<<St/binary, " LIMIT "/utf8>>/binary,
        (erlang:integer_to_binary(N))/binary>>.

-file("src/based/internal/fmt.gleam", 77).
?DOC(false).
-spec offset(binary(), integer()) -> binary().
offset(St, N) ->
    <<<<St/binary, " OFFSET "/utf8>>/binary,
        (erlang:integer_to_binary(N))/binary>>.

-file("src/based/internal/fmt.gleam", 81).
?DOC(false).
-spec for_update(binary()) -> binary().
for_update(St) ->
    <<St/binary, " FOR UPDATE"/utf8>>.

-file("src/based/internal/fmt.gleam", 85).
?DOC(false).
-spec on_conflict(binary(), binary()) -> binary().
on_conflict(St, Target) ->
    <<<<<<St/binary, " ON CONFLICT ("/utf8>>/binary, Target/binary>>/binary,
        ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 89).
?DOC(false).
-spec do_nothing(binary()) -> binary().
do_nothing(St) ->
    <<St/binary, " DO NOTHING"/utf8>>.

-file("src/based/internal/fmt.gleam", 93).
?DOC(false).
-spec do_update(binary(), list(binary())) -> binary().
do_update(St, Assignments) ->
    <<<<St/binary, " DO UPDATE SET "/utf8>>/binary,
        (gleam@string:join(Assignments, <<", "/utf8>>))/binary>>.

-file("src/based/internal/fmt.gleam", 97).
?DOC(false).
-spec inner_join(binary(), binary()) -> binary().
inner_join(St, Value) ->
    <<<<St/binary, " INNER JOIN "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 101).
?DOC(false).
-spec left_join(binary(), binary()) -> binary().
left_join(St, Value) ->
    <<<<St/binary, " LEFT JOIN "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 105).
?DOC(false).
-spec right_join(binary(), binary()) -> binary().
right_join(St, Value) ->
    <<<<St/binary, " RIGHT JOIN "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 109).
?DOC(false).
-spec full_join(binary(), binary()) -> binary().
full_join(St, Value) ->
    <<<<St/binary, " FULL JOIN "/utf8>>/binary, Value/binary>>.

-file("src/based/internal/fmt.gleam", 113).
?DOC(false).
-spec eq(binary(), binary()) -> binary().
eq(Left, Right) ->
    <<<<Left/binary, " = "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 117).
?DOC(false).
-spec not_eq(binary(), binary()) -> binary().
not_eq(Left, Right) ->
    <<<<Left/binary, " != "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 121).
?DOC(false).
-spec gt(binary(), binary()) -> binary().
gt(Left, Right) ->
    <<<<Left/binary, " > "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 125).
?DOC(false).
-spec lt(binary(), binary()) -> binary().
lt(Left, Right) ->
    <<<<Left/binary, " < "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 129).
?DOC(false).
-spec gt_eq(binary(), binary()) -> binary().
gt_eq(Left, Right) ->
    <<<<Left/binary, " >= "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 133).
?DOC(false).
-spec lt_eq(binary(), binary()) -> binary().
lt_eq(Left, Right) ->
    <<<<Left/binary, " <= "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 137).
?DOC(false).
-spec like(binary(), binary()) -> binary().
like(Left, Right) ->
    <<<<Left/binary, " LIKE "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 141).
?DOC(false).
-spec not_like(binary(), binary()) -> binary().
not_like(Left, Right) ->
    <<<<Left/binary, " NOT LIKE "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 145).
?DOC(false).
-spec in_(binary(), binary()) -> binary().
in_(Left, Values) ->
    <<<<<<Left/binary, " IN ("/utf8>>/binary, Values/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 149).
?DOC(false).
-spec is_null(binary()) -> binary().
is_null(Operand) ->
    <<Operand/binary, " IS NULL"/utf8>>.

-file("src/based/internal/fmt.gleam", 153).
?DOC(false).
-spec is_not_null(binary()) -> binary().
is_not_null(Operand) ->
    <<Operand/binary, " IS NOT NULL"/utf8>>.

-file("src/based/internal/fmt.gleam", 157).
?DOC(false).
-spec is_true(binary()) -> binary().
is_true(Operand) ->
    <<Operand/binary, " IS TRUE"/utf8>>.

-file("src/based/internal/fmt.gleam", 161).
?DOC(false).
-spec is_false(binary()) -> binary().
is_false(Operand) ->
    <<Operand/binary, " IS FALSE"/utf8>>.

-file("src/based/internal/fmt.gleam", 165).
?DOC(false).
-spec between(binary(), binary(), binary()) -> binary().
between(Operand, Low, High) ->
    <<<<<<<<Operand/binary, " BETWEEN "/utf8>>/binary, Low/binary>>/binary,
            " AND "/utf8>>/binary,
        High/binary>>.

-file("src/based/internal/fmt.gleam", 169).
?DOC(false).
-spec 'not'(binary()) -> binary().
'not'(Value) ->
    <<<<"NOT ("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 173).
?DOC(false).
-spec exists(binary()) -> binary().
exists(Subquery) ->
    <<<<"EXISTS ("/utf8, Subquery/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 177).
?DOC(false).
-spec and_op(binary(), binary()) -> binary().
and_op(Left, Right) ->
    <<<<<<<<"("/utf8, Left/binary>>/binary, " AND "/utf8>>/binary,
            Right/binary>>/binary,
        ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 181).
?DOC(false).
-spec or_op(binary(), binary()) -> binary().
or_op(Left, Right) ->
    <<<<<<<<"("/utf8, Left/binary>>/binary, " OR "/utf8>>/binary, Right/binary>>/binary,
        ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 185).
?DOC(false).
-spec any(binary()) -> binary().
any(Subquery) ->
    <<<<"ANY ("/utf8, Subquery/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 189).
?DOC(false).
-spec all(binary()) -> binary().
all(Subquery) ->
    <<<<"ALL ("/utf8, Subquery/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 193).
?DOC(false).
-spec subquery(binary()) -> binary().
subquery(Query) ->
    <<<<"("/utf8, Query/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 197).
?DOC(false).
-spec count(binary()) -> binary().
count(Value) ->
    <<<<"COUNT("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 201).
?DOC(false).
-spec sum(binary()) -> binary().
sum(Value) ->
    <<<<"SUM("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 205).
?DOC(false).
-spec avg(binary()) -> binary().
avg(Value) ->
    <<<<"AVG("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 209).
?DOC(false).
-spec max(binary()) -> binary().
max(Value) ->
    <<<<"MAX("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 213).
?DOC(false).
-spec min(binary()) -> binary().
min(Value) ->
    <<<<"MIN("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 217).
?DOC(false).
-spec with_cte(binary()) -> binary().
with_cte(Ctes) ->
    <<"WITH "/utf8, Ctes/binary>>.

-file("src/based/internal/fmt.gleam", 221).
?DOC(false).
-spec with_recursive(binary()) -> binary().
with_recursive(Ctes) ->
    <<"WITH RECURSIVE "/utf8, Ctes/binary>>.

-file("src/based/internal/fmt.gleam", 225).
?DOC(false).
-spec cte(binary(), binary()) -> binary().
cte(Name, Body) ->
    <<<<<<Name/binary, " AS ("/utf8>>/binary, Body/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 229).
?DOC(false).
-spec union(binary(), binary()) -> binary().
union(Left, Right) ->
    <<<<Left/binary, " UNION "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 233).
?DOC(false).
-spec union_all(binary(), binary()) -> binary().
union_all(Left, Right) ->
    <<<<Left/binary, " UNION ALL "/utf8>>/binary, Right/binary>>.

-file("src/based/internal/fmt.gleam", 238).
?DOC(false).
-spec enclose(binary()) -> binary().
enclose(Value) ->
    <<<<"("/utf8, Value/binary>>/binary, ")"/utf8>>.

-file("src/based/internal/fmt.gleam", 243).
?DOC(false).
-spec alias_as(binary(), binary()) -> binary().
alias_as(Value, Alias) ->
    <<<<Value/binary, " AS "/utf8>>/binary, Alias/binary>>.

-file("src/based/internal/fmt.gleam", 248).
?DOC(false).
-spec asc(binary()) -> binary().
asc(Value) ->
    <<Value/binary, " ASC"/utf8>>.

-file("src/based/internal/fmt.gleam", 253).
?DOC(false).
-spec desc(binary()) -> binary().
desc(Value) ->
    <<Value/binary, " DESC"/utf8>>.

-file("src/based/internal/fmt.gleam", 258).
?DOC(false).
-spec terminate(binary()) -> binary().
terminate(Value) ->
    <<Value/binary, ";"/utf8>>.
Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT