Skip to content
This repository was archived by the owner on May 13, 2023. It is now read-only.

Commit c9216f4

Browse files
dshukertjrdshukertjr
authored
fix: delete() now does not return data by default and comments cleanup (#105)
* fix: delete is returning minimal by default now * format the comments docs * fix the comments in postgrest_transoform builder * put returning back and deprecate it
1 parent 47c25c1 commit c9216f4

4 files changed

+210
-37
lines changed

‎lib/src/postgrest_filter_builder.dart

+92-23
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
1515
/// Finds all rows which doesn't satisfy the filter.
1616
///
1717
/// ```dart
18-
/// postgrest.from('users').select().not('status', 'eq', 'OFFLINE')
18+
/// await supabase
19+
/// .from('users')
20+
/// .select()
21+
/// .not('status', 'eq', 'OFFLINE');
1922
/// ```
2023
PostgrestFilterBuilder<T> not(String column, String operator, dynamic value) {
2124
if (value is List) {
@@ -39,7 +42,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
3942
/// Finds all rows satisfying at least one of the filters.
4043
///
4144
/// ```dart
42-
/// postgrest.from('users').select().or('status.eq.OFFLINE,username.eq.supabot')
45+
/// await supabase
46+
/// .from('users')
47+
/// .select()
48+
/// .or('status.eq.OFFLINE,username.eq.supabot');
4349
/// ```
4450
PostgrestFilterBuilder<T> or(String filters, {String? foreignTable}) {
4551
final key = foreignTable != null ? '"$foreignTable".or' : 'or';
@@ -50,7 +56,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
5056
/// Finds all rows whose value on the stated [column] exactly matches the specified [value].
5157
///
5258
/// ```dart
53-
/// postgrest.from('users').select().eq('username', 'supabot')
59+
/// await supabase
60+
/// .from('users')
61+
/// .select()
62+
/// .eq('username', 'supabot');
5463
/// ```
5564
PostgrestFilterBuilder<T> eq(String column, dynamic value) {
5665
if (value is List) {
@@ -64,7 +73,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
6473
/// Finds all rows whose value on the stated [column] doesn't match the specified [value].
6574
///
6675
/// ```dart
67-
/// postgrest.from('users').select().neq('username', 'supabot')
76+
/// await supabase
77+
/// .from('users')
78+
/// .select()
79+
/// .neq('username', 'supabot');
6880
/// ```
6981
PostgrestFilterBuilder<T> neq(String column, dynamic value) {
7082
if (value is List) {
@@ -78,7 +90,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
7890
/// Finds all rows whose value on the stated [column] is greater than the specified [value].
7991
///
8092
/// ```dart
81-
/// postgrest.from('messages').select().gt('id', 1)
93+
/// await supabase
94+
/// .from('messages')
95+
/// .select()
96+
/// .gt('id', 1);
8297
/// ```
8398
PostgrestFilterBuilder<T> gt(String column, dynamic value) {
8499
appendSearchParams(column, 'gt.$value');
@@ -88,7 +103,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
88103
/// Finds all rows whose value on the stated [column] is greater than or equal to the specified [value].
89104
///
90105
/// ```dart
91-
/// postgrest.from('messages').select().gte('id', 1)
106+
/// await supabase
107+
/// .from('messages')
108+
/// .select()
109+
/// .gte('id', 1);
92110
/// ```
93111
PostgrestFilterBuilder<T> gte(String column, dynamic value) {
94112
appendSearchParams(column, 'gte.$value');
@@ -98,7 +116,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
98116
/// Finds all rows whose value on the stated [column] is less than the specified [value].
99117
///
100118
/// ```dart
101-
/// postgrest.from('messages').select().lt('id', 2)
119+
/// await supabase
120+
/// .from('messages')
121+
/// .select()
122+
/// .lt('id', 2);
102123
/// ```
103124
PostgrestFilterBuilder<T> lt(String column, dynamic value) {
104125
appendSearchParams(column, 'lt.$value');
@@ -108,7 +129,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
108129
/// Finds all rows whose value on the stated [column] is less than or equal to the specified [value].
109130
///
110131
/// ```dart
111-
/// postgrest.from('messages').select().lte('id', 2)
132+
/// await supabase
133+
/// .from('messages')
134+
/// .select()
135+
/// .lte('id', 2);
112136
/// ```
113137
PostgrestFilterBuilder<T> lte(String column, dynamic value) {
114138
appendSearchParams(column, 'lte.$value');
@@ -118,7 +142,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
118142
/// Finds all rows whose value in the stated [column] matches the supplied [pattern] (case sensitive).
119143
///
120144
/// ```dart
121-
/// postgrest.from('users').select().like('username', '%supa%')
145+
/// await supabase
146+
/// .from('users')
147+
/// .select()
148+
/// .like('username', '%supa%');
122149
/// ```
123150
PostgrestFilterBuilder<T> like(String column, String pattern) {
124151
appendSearchParams(column, 'like.$pattern');
@@ -128,7 +155,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
128155
/// Finds all rows whose value in the stated [column] matches the supplied [pattern] (case insensitive).
129156
///
130157
/// ```dart
131-
/// postgrest.from('users').select().ilike('username', '%SUPA%')
158+
/// await supabase
159+
/// .from('users')
160+
/// .select()
161+
/// .ilike('username', '%SUPA%');
132162
/// ```
133163
PostgrestFilterBuilder<T> ilike(String column, String pattern) {
134164
appendSearchParams(column, 'ilike.$pattern');
@@ -139,7 +169,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
139169
///
140170
/// Finds all rows whose value on the stated [column] exactly match the specified [value].
141171
/// ```dart
142-
/// postgrest.from('users').select().is_('data', null)
172+
/// await supabase
173+
/// .from('users')
174+
/// .select()
175+
/// .is_('data', null);
143176
/// ```
144177
// ignore: non_constant_identifier_names
145178
PostgrestFilterBuilder<T> is_(String column, dynamic value) {
@@ -150,7 +183,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
150183
/// Finds all rows whose value on the stated [column] is found on the specified [values].
151184
///
152185
/// ```dart
153-
/// postgrest.from('users').select().in_('status', ['ONLINE', 'OFFLINE'])
186+
/// await supabase
187+
/// .from('users')
188+
/// .select()
189+
/// .in_('status', ['ONLINE', 'OFFLINE']);
154190
/// ```
155191
// ignore: non_constant_identifier_names
156192
PostgrestFilterBuilder<T> in_(String column, List values) {
@@ -161,7 +197,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
161197
/// Finds all rows whose json, array, or range value on the stated [column] contains the values specified in [value].
162198
///
163199
/// ```dart
164-
/// postgrest.from('users').select().contains('age_range', '[1,2)')
200+
/// await supabase
201+
/// .from('users')
202+
/// .select()
203+
/// .contains('age_range', '[1,2)');
165204
/// ```
166205
PostgrestFilterBuilder<T> contains(String column, dynamic value) {
167206
if (value is String) {
@@ -181,7 +220,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
181220
/// Finds all rows whose json, array, or range value on the stated [column] is contained by the specified [value].
182221
///
183222
/// ```dart
184-
/// postgrest.from('users').select().containedBy('age_range', '[1,2)')
223+
/// await supabase
224+
/// .from('users')
225+
/// .select()
226+
/// .containedBy('age_range', '[1,2)');
185227
/// ```
186228
PostgrestFilterBuilder<T> containedBy(String column, dynamic value) {
187229
if (value is String) {
@@ -201,7 +243,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
201243
/// Finds all rows whose range value on the stated [column] is strictly to the left of the specified [range].
202244
///
203245
/// ```dart
204-
/// postgrest.from('users').select().sl('age_range', '[2,25)')
246+
/// await supabase
247+
/// .from('users')
248+
/// .select()
249+
/// .sl('age_range', '[2,25)');
205250
/// ```
206251
PostgrestFilterBuilder<T> rangeLt(String column, String range) {
207252
appendSearchParams(column, 'sl.$range');
@@ -211,7 +256,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
211256
/// Finds all rows whose range value on the stated [column] is strictly to the right of the specified [range].
212257
///
213258
/// ```dart
214-
/// postgrest.from('users').select().rangeGt('age_range', '[2,25)')
259+
/// await supabase
260+
/// .from('users')
261+
/// .select()
262+
/// .rangeGt('age_range', '[2,25)');
215263
/// ```
216264
PostgrestFilterBuilder<T> rangeGt(String column, String range) {
217265
appendSearchParams(column, 'sr.$range');
@@ -221,7 +269,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
221269
/// Finds all rows whose range value on the stated [column] does not extend to the left of the specified [range].
222270
///
223271
/// ```dart
224-
/// postgrest.from('users').select().rangeGte('age_range', '[2,25)')
272+
/// await supabase
273+
/// .from('users')
274+
/// .select()
275+
/// .rangeGte('age_range', '[2,25)');
225276
/// ```
226277
PostgrestFilterBuilder<T> rangeGte(String column, String range) {
227278
appendSearchParams(column, 'nxl.$range');
@@ -231,7 +282,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
231282
/// Finds all rows whose range value on the stated [column] does not extend to the right of the specified [range].
232283
///
233284
/// ```dart
234-
/// postgrest.from('users').select().rangeLte('age_range', '[2,25)')
285+
/// await supabase
286+
/// .from('users')
287+
/// .select()
288+
/// .rangeLte('age_range', '[2,25)');
235289
/// ```
236290
PostgrestFilterBuilder<T> rangeLte(String column, String range) {
237291
appendSearchParams(column, 'nxr.$range');
@@ -241,7 +295,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
241295
/// Finds all rows whose range value on the stated [column] is adjacent to the specified [range].
242296
///
243297
/// ```dart
244-
/// postgrest.from('users').select().rangeAdjacent('age_range', '[2,25)')
298+
/// await supabase
299+
/// .from('users')
300+
/// .select()
301+
/// .rangeAdjacent('age_range', '[2,25)');
245302
/// ```
246303
PostgrestFilterBuilder<T> rangeAdjacent(String column, String range) {
247304
appendSearchParams(column, 'adj.$range');
@@ -251,7 +308,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
251308
/// Finds all rows whose array or range value on the stated [column] overlaps (has a value in common) with the specified [value].
252309
///
253310
/// ```dart
254-
/// postgrest.from('users').select().overlaps('age_range', '[2,25)')
311+
/// await supabase
312+
/// .from('users')
313+
/// .select()
314+
/// .overlaps('age_range', '[2,25)');
255315
/// ```
256316
PostgrestFilterBuilder<T> overlaps(String column, dynamic value) {
257317
if (value is String) {
@@ -268,7 +328,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
268328
/// Finds all rows whose text or tsvector value on the stated [column] matches the tsquery in [query].
269329
///
270330
/// ```dart
271-
/// postgrest.from('users').select().textSearch('catchphrase', "'fat' & 'cat'", config: 'english')
331+
/// await supabase
332+
/// .from('users')
333+
/// .select()
334+
/// .textSearch('catchphrase', "'fat' & 'cat'", config: 'english');
272335
/// ```
273336
PostgrestFilterBuilder<T> textSearch(
274337
String column,
@@ -296,7 +359,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
296359
/// Finds all rows whose [column] satisfies the filter.
297360
///
298361
/// ```dart
299-
/// postgrest.from('users').select().filter('username', 'eq', 'supabot')
362+
/// await supabase
363+
/// .from('users')
364+
/// .select()
365+
/// .filter('username', 'eq', 'supabot');
300366
/// ```
301367
PostgrestFilterBuilder<T> filter(
302368
String column, String operator, dynamic value) {
@@ -322,7 +388,10 @@ class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder<T> {
322388
///
323389
/// [query] contains column names as keys mapped to their filter values.
324390
/// ```dart
325-
/// postgrest.from('users').select().match({'username': 'supabot', 'status': 'ONLINE'})
391+
/// await supabase.from('users').select().match({
392+
/// 'username': 'supabot',
393+
/// 'status': 'ONLINE',
394+
/// });
326395
/// ```
327396
PostgrestFilterBuilder<T> match(Map query) {
328397
query.forEach((k, v) => appendSearchParams('$k', 'eq.$v'));

0 commit comments

Comments
 (0)