Skip to content

Commit 5914dea

Browse files
authored
refactor: rename some postgrest function parameters (#143)
1 parent 32e426e commit 5914dea

File tree

6 files changed

+88
-88
lines changed

6 files changed

+88
-88
lines changed

Sources/PostgREST/PostgrestClient.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public actor PostgrestClient {
115115
/// - Returns: A PostgrestTransformBuilder instance.
116116
/// - Throws: An error if the function call fails.
117117
public func rpc(
118-
fn: String,
118+
_ fn: String,
119119
params: some Encodable,
120120
count: CountOption? = nil
121121
) throws -> PostgrestTransformBuilder {
@@ -133,10 +133,10 @@ public actor PostgrestClient {
133133
/// - Returns: A PostgrestTransformBuilder instance.
134134
/// - Throws: An error if the function call fails.
135135
public func rpc(
136-
fn: String,
136+
_ fn: String,
137137
count: CountOption? = nil
138138
) throws -> PostgrestTransformBuilder {
139-
try rpc(fn: fn, params: NoParams(), count: count)
139+
try rpc(fn, params: NoParams(), count: count)
140140
}
141141
}
142142

Sources/PostgREST/PostgrestFilterBuilder.swift

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
99

1010
// MARK: - Filters
1111

12-
public func not(column: String, operator op: Operator, value: URLQueryRepresentable)
12+
public func not(_ column: String, operator op: Operator, value: URLQueryRepresentable)
1313
-> PostgrestFilterBuilder
1414
{
1515
mutableState.withValue {
@@ -29,70 +29,70 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
2929
return self
3030
}
3131

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

142-
public func rangeAdjacent(column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder
142+
public func rangeAdjacent(_ column: String, range: URLQueryRepresentable) -> PostgrestFilterBuilder
143143
{
144144
mutableState.withValue {
145145
$0.request.query.append(URLQueryItem(name: column, value: "adj.\(range.queryValue)"))
146146
}
147147
return self
148148
}
149149

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

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

164164
public func textSearch(
165-
column: String, query: URLQueryRepresentable, config: String? = nil, type: TextSearchType? = nil
165+
_ column: String, query: URLQueryRepresentable, config: String? = nil, type: TextSearchType? = nil
166166
) -> PostgrestFilterBuilder {
167167
mutableState.withValue {
168168
$0.request.query.append(
@@ -174,7 +174,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
174174
return self
175175
}
176176

177-
public func fts(column: String, query: URLQueryRepresentable, config: String? = nil)
177+
public func fts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
178178
-> PostgrestFilterBuilder
179179
{
180180
mutableState.withValue {
@@ -186,7 +186,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
186186
return self
187187
}
188188

189-
public func plfts(column: String, query: URLQueryRepresentable, config: String? = nil)
189+
public func plfts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
190190
-> PostgrestFilterBuilder
191191
{
192192
mutableState.withValue {
@@ -198,7 +198,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
198198
return self
199199
}
200200

201-
public func phfts(column: String, query: URLQueryRepresentable, config: String? = nil)
201+
public func phfts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
202202
-> PostgrestFilterBuilder
203203
{
204204
mutableState.withValue {
@@ -210,7 +210,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
210210
return self
211211
}
212212

213-
public func wfts(column: String, query: URLQueryRepresentable, config: String? = nil)
213+
public func wfts(_ column: String, query: URLQueryRepresentable, config: String? = nil)
214214
-> PostgrestFilterBuilder
215215
{
216216
mutableState.withValue {
@@ -222,7 +222,7 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
222222
return self
223223
}
224224

225-
public func filter(column: String, operator: Operator, value: URLQueryRepresentable)
225+
public func filter(_ column: String, operator: Operator, value: URLQueryRepresentable)
226226
-> PostgrestFilterBuilder
227227
{
228228
mutableState.withValue {
@@ -248,67 +248,67 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder {
248248

249249
// MARK: - Filter Semantic Improvements
250250

251-
public func equals(column: String, value: String) -> PostgrestFilterBuilder {
252-
eq(column: column, value: value)
251+
public func equals(_ column: String, value: String) -> PostgrestFilterBuilder {
252+
eq(column, value: value)
253253
}
254254

255-
public func notEquals(column: String, value: String) -> PostgrestFilterBuilder {
256-
neq(column: column, value: value)
255+
public func notEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
256+
neq(column, value: value)
257257
}
258258

259-
public func greaterThan(column: String, value: String) -> PostgrestFilterBuilder {
260-
gt(column: column, value: value)
259+
public func greaterThan(_ column: String, value: String) -> PostgrestFilterBuilder {
260+
gt(column, value: value)
261261
}
262262

263-
public func greaterThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
264-
gte(column: column, value: value)
263+
public func greaterThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
264+
gte(column, value: value)
265265
}
266266

267-
public func lowerThan(column: String, value: String) -> PostgrestFilterBuilder {
268-
lt(column: column, value: value)
267+
public func lowerThan(_ column: String, value: String) -> PostgrestFilterBuilder {
268+
lt(column, value: value)
269269
}
270270

271-
public func lowerThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
272-
lte(column: column, value: value)
271+
public func lowerThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
272+
lte(column, value: value)
273273
}
274274

275-
public func rangeLowerThan(column: String, range: String) -> PostgrestFilterBuilder {
276-
rangeLt(column: column, range: range)
275+
public func rangeLowerThan(_ column: String, range: String) -> PostgrestFilterBuilder {
276+
rangeLt(column, range: range)
277277
}
278278

279-
public func rangeGreaterThan(column: String, value: String) -> PostgrestFilterBuilder {
280-
rangeGt(column: column, range: value)
279+
public func rangeGreaterThan(_ column: String, value: String) -> PostgrestFilterBuilder {
280+
rangeGt(column, range: value)
281281
}
282282

283-
public func rangeGreaterThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
284-
rangeGte(column: column, range: value)
283+
public func rangeGreaterThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
284+
rangeGte(column, range: value)
285285
}
286286

287-
public func rangeLowerThanOrEquals(column: String, value: String) -> PostgrestFilterBuilder {
288-
rangeLte(column: column, range: value)
287+
public func rangeLowerThanOrEquals(_ column: String, value: String) -> PostgrestFilterBuilder {
288+
rangeLte(column, range: value)
289289
}
290290

291-
public func fullTextSearch(column: String, query: String, config: String? = nil)
291+
public func fullTextSearch(_ column: String, query: String, config: String? = nil)
292292
-> PostgrestFilterBuilder
293293
{
294-
fts(column: column, query: query, config: config)
294+
fts(column, query: query, config: config)
295295
}
296296

297-
public func plainToFullTextSearch(column: String, query: String, config: String? = nil)
297+
public func plainToFullTextSearch(_ column: String, query: String, config: String? = nil)
298298
-> PostgrestFilterBuilder
299299
{
300-
plfts(column: column, query: query, config: config)
300+
plfts(column, query: query, config: config)
301301
}
302302

303-
public func phraseToFullTextSearch(column: String, query: String, config: String? = nil)
303+
public func phraseToFullTextSearch(_ column: String, query: String, config: String? = nil)
304304
-> PostgrestFilterBuilder
305305
{
306-
phfts(column: column, query: query, config: config)
306+
phfts(column, query: query, config: config)
307307
}
308308

309-
public func webFullTextSearch(column: String, query: String, config: String? = nil)
309+
public func webFullTextSearch(_ column: String, query: String, config: String? = nil)
310310
-> PostgrestFilterBuilder
311311
{
312-
wfts(column: column, query: query, config: config)
312+
wfts(column, query: query, config: config)
313313
}
314314
}

Sources/PostgREST/PostgrestQueryBuilder.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
99
/// - count: Count algorithm to use to count rows in a table.
1010
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
1111
public func select(
12-
columns: String = "*",
12+
_ columns: String = "*",
1313
head: Bool = false,
1414
count: CountOption? = nil
1515
) -> PostgrestFilterBuilder {
@@ -49,7 +49,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
4949
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
5050
/// - Throws: An error if the insert fails.
5151
public func insert(
52-
values: some Encodable,
52+
_ values: some Encodable,
5353
returning: PostgrestReturningOptions? = nil,
5454
count: CountOption? = nil
5555
) throws -> PostgrestFilterBuilder {
@@ -93,7 +93,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
9393
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
9494
/// - Throws: An error if the upsert fails.
9595
public func upsert(
96-
values: some Encodable,
96+
_ values: some Encodable,
9797
onConflict: String? = nil,
9898
returning: PostgrestReturningOptions = .representation,
9999
count: CountOption? = nil,
@@ -130,7 +130,7 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
130130
/// - Returns: A `PostgrestFilterBuilder` instance for further filtering or operations.
131131
/// - Throws: An error if the update fails.
132132
public func update(
133-
values: some Encodable,
133+
_ values: some Encodable,
134134
returning: PostgrestReturningOptions = .representation,
135135
count: CountOption? = nil
136136
) throws -> PostgrestFilterBuilder {

Sources/PostgREST/PostgrestTransformBuilder.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder {
55
/// Performs a vertical filtering with SELECT.
66
/// - Parameters:
77
/// - columns: The columns to retrieve, separated by commas.
8-
public func select(columns: String = "*") -> PostgrestTransformBuilder {
8+
public func select(_ columns: String = "*") -> PostgrestTransformBuilder {
99
// remove whitespaces except when quoted.
1010
var quoted = false
1111
let cleanedColumns = columns.compactMap { char -> String? in
@@ -31,7 +31,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder {
3131
/// - nullsFirst: If `true`, `null`s appear first.
3232
/// - foreignTable: The foreign table to use (if `column` is a foreign column).
3333
public func order(
34-
column: String,
34+
_ column: String,
3535
ascending: Bool = true,
3636
nullsFirst: Bool = false,
3737
foreignTable: String? = nil
@@ -61,7 +61,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder {
6161
/// - Parameters:
6262
/// - count: The maximum no. of rows to limit to.
6363
/// - foreignTable: The foreign table to use (for foreign columns).
64-
public func limit(count: Int, foreignTable: String? = nil) -> PostgrestTransformBuilder {
64+
public func limit(_ count: Int, foreignTable: String? = nil) -> PostgrestTransformBuilder {
6565
mutableState.withValue {
6666
let key = foreignTable.map { "\($0).limit" } ?? "limit"
6767
if let index = $0.request.query.firstIndex(where: { $0.name == key }) {

0 commit comments

Comments
 (0)