Skip to content

refactor: rename some PostgREST function parameters #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Sources/PostgREST/PostgrestClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public actor PostgrestClient {
/// - Returns: A PostgrestTransformBuilder instance.
/// - Throws: An error if the function call fails.
public func rpc(
fn: String,
_ fn: String,
params: some Encodable,
count: CountOption? = nil
) throws -> PostgrestTransformBuilder {
Expand All @@ -133,10 +133,10 @@ public actor PostgrestClient {
/// - Returns: A PostgrestTransformBuilder instance.
/// - Throws: An error if the function call fails.
public func rpc(
fn: String,
_ fn: String,
count: CountOption? = nil
) throws -> PostgrestTransformBuilder {
try rpc(fn: fn, params: NoParams(), count: count)
try rpc(fn, params: NoParams(), count: count)
}
}

Expand Down
106 changes: 53 additions & 53 deletions Sources/PostgREST/PostgrestFilterBuilder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {

// MARK: - Filters

public func not(column: String, operator op: Operator, value: URLQueryRepresentable)
public func not(_ column: String, operator op: Operator, value: URLQueryRepresentable)
-> PostgrestFilterBuilder
{
mutableState.withValue {
Expand All @@ -29,70 +29,70 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func eq(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func eq(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "eq.\(value.queryValue)"))
}
return self
}

public func neq(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func neq(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "neq.\(value.queryValue)"))
}
return self
}

public func gt(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func gt(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "gt.\(value.queryValue)"))
}
return self
}

public func gte(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func gte(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "gte.\(value.queryValue)"))
}
return self
}

public func lt(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func lt(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "lt.\(value.queryValue)"))
}
return self
}

public func lte(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func lte(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "lte.\(value.queryValue)"))
}
return self
}

public func like(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func like(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "like.\(value.queryValue)"))
}
return self
}

public func ilike(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func ilike(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "ilike.\(value.queryValue)"))
}
return self
}

public func `is`(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func `is`(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "is.\(value.queryValue)"))
}
return self
}

public func `in`(column: String, value: [URLQueryRepresentable]) -> PostgrestFilterBuilder {
public func `in`(_ column: String, value: [URLQueryRepresentable]) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(
URLQueryItem(
Expand All @@ -104,65 +104,65 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func contains(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func contains(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "cs.\(value.queryValue)"))
}
return self
}

public func rangeLt(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func rangeLt(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "sl.\(range.queryValue)"))
}
return self
}

public func rangeGt(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func rangeGt(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "sr.\(range.queryValue)"))
}
return self
}

public func rangeGte(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func rangeGte(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "nxl.\(range.queryValue)"))
}
return self
}

public func rangeLte(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func rangeLte(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "nxr.\(range.queryValue)"))
}
return self
}

public func rangeAdjacent(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder
public func rangeAdjacent(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder
{
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "adj.\(range.queryValue)"))
}
return self
}

public func overlaps(column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func overlaps(_ column: String, value: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "ov.\(value.queryValue)"))
}
return self
}

public func textSearch(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
public func textSearch(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(URLQueryItem(name: column, value: "adj.\(range.queryValue)"))
}
return self
}

public func textSearch(
column: String, query: URLQueryRepresentable, config: String? = nil, type: TextSearchType? = nil
_ column: String, query: URLQueryRepresentable, config: String? = nil, type: TextSearchType? = nil
) -> PostgrestFilterBuilder {
mutableState.withValue {
$0.request.query.append(
Expand All @@ -174,7 +174,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func fts(column: String, query: URLQueryRepresentable, config: String? = nil)
public func fts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
-> PostgrestFilterBuilder
{
mutableState.withValue {
Expand All @@ -186,7 +186,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func plfts(column: String, query: URLQueryRepresentable, config: String? = nil)
public func plfts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
-> PostgrestFilterBuilder
{
mutableState.withValue {
Expand All @@ -198,7 +198,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func phfts(column: String, query: URLQueryRepresentable, config: String? = nil)
public func phfts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
-> PostgrestFilterBuilder
{
mutableState.withValue {
Expand All @@ -210,7 +210,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func wfts(column: String, query: URLQueryRepresentable, config: String? = nil)
public func wfts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
-> PostgrestFilterBuilder
{
mutableState.withValue {
Expand All @@ -222,7 +222,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
return self
}

public func filter(column: String, operator: Operator, value: URLQueryRepresentable)
public func filter(_ column: String, operator: Operator, value: URLQueryRepresentable)
-> PostgrestFilterBuilder
{
mutableState.withValue {
Expand All @@ -248,67 +248,67 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {

// MARK: - Filter Semantic Improvements

public func equals(column: String, value: String) -> PostgrestFilterBuilder {
eq(column: column, value: value)
public func equals(_ column: String, value: String) -> PostgrestFilterBuilder {
eq(column, value: value)
}

public func notEquals(column: String, value: String) -> PostgrestFilterBuilder {
neq(column: column, value: value)
public func notEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
neq(column, value: value)
}

public func greaterThan(column: String, value: String) -> PostgrestFilterBuilder {
gt(column: column, value: value)
public func greaterThan(_ column: String, value: String) -> PostgrestFilterBuilder {
gt(column, value: value)
}

public func greaterThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
gte(column: column, value: value)
public func greaterThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
gte(column, value: value)
}

public func lowerThan(column: String, value: String) -> PostgrestFilterBuilder {
lt(column: column, value: value)
public func lowerThan(_ column: String, value: String) -> PostgrestFilterBuilder {
lt(column, value: value)
}

public func lowerThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
lte(column: column, value: value)
public func lowerThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
lte(column, value: value)
}

public func rangeLowerThan(column: String, range: String) -> PostgrestFilterBuilder {
rangeLt(column: column, range: range)
public func rangeLowerThan(_ column: String, range: String) -> PostgrestFilterBuilder {
rangeLt(column, range: range)
}

public func rangeGreaterThan(column: String, value: String) -> PostgrestFilterBuilder {
rangeGt(column: column, range: value)
public func rangeGreaterThan(_ column: String, value: String) -> PostgrestFilterBuilder {
rangeGt(column, range: value)
}

public func rangeGreaterThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
rangeGte(column: column, range: value)
public func rangeGreaterThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
rangeGte(column, range: value)
}

public func rangeLowerThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
rangeLte(column: column, range: value)
public func rangeLowerThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
rangeLte(column, range: value)
}

public func fullTextSearch(column: String, query: String, config: String? = nil)
public func fullTextSearch(_ column: String, query: String, config: String? = nil)
-> PostgrestFilterBuilder
{
fts(column: column, query: query, config: config)
fts(column, query: query, config: config)
}

public func plainToFullTextSearch(column: String, query: String, config: String? = nil)
public func plainToFullTextSearch(_ column: String, query: String, config: String? = nil)
-> PostgrestFilterBuilder
{
plfts(column: column, query: query, config: config)
plfts(column, query: query, config: config)
}

public func phraseToFullTextSearch(column: String, query: String, config: String? = nil)
public func phraseToFullTextSearch(_ column: String, query: String, config: String? = nil)
-> PostgrestFilterBuilder
{
phfts(column: column, query: query, config: config)
phfts(column, query: query, config: config)
}

public func webFullTextSearch(column: String, query: String, config: String? = nil)
public func webFullTextSearch(_ column: String, query: String, config: String? = nil)
-> PostgrestFilterBuilder
{
wfts(column: column, query: query, config: config)
wfts(column, query: query, config: config)
}
}
8 changes: 4 additions & 4 deletions Sources/PostgREST/PostgrestQueryBuilder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
/// - count: Count algorithm to use to count rows in a table.
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
public func select(
columns: String = "*",
_ columns: String = "*",
head: Bool = false,
count: CountOption? = nil
) -> PostgrestFilterBuilder {
Expand Down Expand Up @@ -49,7 +49,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
/// - Throws: An error if the insert fails.
public func insert(
values: some Encodable,
_ values: some Encodable,
returning: PostgrestReturningOptions? = nil,
count: CountOption? = nil
) throws -> PostgrestFilterBuilder {
Expand Down Expand Up @@ -93,7 +93,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
/// - Throws: An error if the upsert fails.
public func upsert(
values: some Encodable,
_ values: some Encodable,
onConflict: String? = nil,
returning: PostgrestReturningOptions = .representation,
count: CountOption? = nil,
Expand Down Expand Up @@ -130,7 +130,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
/// - Throws: An error if the update fails.
public func update(
values: some Encodable,
_ values: some Encodable,
returning: PostgrestReturningOptions = .representation,
count: CountOption? = nil
) throws -> PostgrestFilterBuilder {
Expand Down
6 changes: 3 additions & 3 deletions Sources/PostgREST/PostgrestTransformBuilder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder {
/// Performs a vertical filtering with SELECT.
/// - Parameters:
/// - columns: The columns to retrieve, separated by commas.
public func select(columns: String = "*") -> PostgrestTransformBuilder {
public func select(_ columns: String = "*") -> PostgrestTransformBuilder {
// remove whitespaces except when quoted.
var quoted = false
let cleanedColumns = columns.compactMap { char -> String? in
Expand All @@ -31,7 +31,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder {
/// - nullsFirst: If `true`, `null`s appear first.
/// - foreignTable: The foreign table to use (if `column` is a foreign column).
public func order(
column: String,
_ column: String,
ascending: Bool = true,
nullsFirst: Bool = false,
foreignTable: String? = nil
Expand Down Expand Up @@ -61,7 +61,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder {
/// - Parameters:
/// - count: The maximum no. of rows to limit to.
/// - foreignTable: The foreign table to use (for foreign columns).
public func limit(count: Int, foreignTable: String? = nil) -> PostgrestTransformBuilder {
public func limit(_ count: Int, foreignTable: String? = nil) -> PostgrestTransformBuilder {
mutableState.withValue {
let key = foreignTable.map { "\($0).limit" } ?? "limit"
if let index = $0.request.query.firstIndex(where: { $0.name == key }) {
Expand Down
Loading