Class: Appwrite::TablesDB

Inherits:
Service
  • Object
show all
Defined in:
lib/appwrite/services/tables_db.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TablesDB

Returns a new instance of TablesDB.



6
7
8
 
# File 'lib/appwrite/services/tables_db.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#create(database_id:, name:, enabled: nil) ⇒ Database

Create a new Database.

Parameters:

  • database_id (String) —

    Unique Id. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • name (String) —

    Database name. Max length: 128 chars.

  • [] —

    enabled Is the database enabled? When set to ‘disabled’, users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.

Returns:

  • (Database) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/appwrite/services/tables_db.rb', line 47

def create(database_id:, name:, enabled: nil)
    api_path = '/tablesdb'

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        databaseId: database_id,
        name: name,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Database
    )
end

#create_boolean_column(database_id:, table_id:, key:, required:, default: nil, array: nil) ⇒ ColumnBoolean

Create a boolean column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • [] —

    default Default value for column when not provided. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnBoolean) 


592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/appwrite/services/tables_db.rb', line 592

def create_boolean_column(database_id:, table_id:, key:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/boolean'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnBoolean
    )
end

#create_datetime_column(database_id:, table_id:, key:, required:, default: nil, array: nil) ⇒ ColumnDatetime

Create a date time column according to the ISO 8601 standard.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) (defaults to: nil) —

    Default value for the column in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnDatetime) 


699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/appwrite/services/tables_db.rb', line 699

def create_datetime_column(database_id:, table_id:, key:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/datetime'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnDatetime
    )
end

#create_email_column(database_id:, table_id:, key:, required:, default: nil, array: nil) ⇒ ColumnEmail

Create an email column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) (defaults to: nil) —

    Default value for column when not provided. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnEmail) 


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/appwrite/services/tables_db.rb', line 807

def create_email_column(database_id:, table_id:, key:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/email'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnEmail
    )
end

#create_enum_column(database_id:, table_id:, key:, elements:, required:, default: nil, array: nil) ⇒ ColumnEnum

Create an enumeration column. The ‘elements` param acts as a white-list of accepted values for this column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • elements (Array) —

    Array of enum values.

  • [] —

    required Is column required?

  • default (String) (defaults to: nil) —

    Default value for column when not provided. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnEnum) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/appwrite/services/tables_db.rb', line 917

def create_enum_column(database_id:, table_id:, key:, elements:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/enum'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if elements.nil?
      raise Appwrite::Exception.new('Missing required parameter: "elements"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        elements: elements,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnEnum
    )
end

#create_float_column(database_id:, table_id:, key:, required:, min: nil, max: nil, default: nil, array: nil) ⇒ ColumnFloat

Create a float column. Optionally, minimum and maximum values can be provided.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • min (Float) (defaults to: nil) —

    Minimum value

  • max (Float) (defaults to: nil) —

    Maximum value

  • default (Float) (defaults to: nil) —

    Default value. Cannot be set when required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnFloat) 


1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/appwrite/services/tables_db.rb', line 1040

def create_float_column(database_id:, table_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/float'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        min: min,
        max: max,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnFloat
    )
end

#create_index(database_id:, table_id:, key:, type:, columns:, orders: nil, lengths: nil) ⇒ ColumnIndex

Creates an index on the columns listed. Your index should include all the columns you will query in a single request. Type can be ‘key`, `fulltext`, or `unique`.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Index Key.

  • type (IndexType) —

    Index type.

  • columns (Array) —

    Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.

  • orders (Array) (defaults to: nil) —

    Array of index orders. Maximum of 100 orders are allowed.

  • lengths (Array) (defaults to: nil) —

    Length of index. Maximum of 100

Returns:

  • (ColumnIndex) 


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
 
# File 'lib/appwrite/services/tables_db.rb', line 2136

def create_index(database_id:, table_id:, key:, type:, columns:, orders: nil, lengths: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/indexes'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    if columns.nil?
      raise Appwrite::Exception.new('Missing required parameter: "columns"')
    end

    api_params = {
        key: key,
        type: type,
        columns: columns,
        orders: orders,
        lengths: lengths,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnIndex
    )
end

#create_integer_column(database_id:, table_id:, key:, required:, min: nil, max: nil, default: nil, array: nil) ⇒ ColumnInteger

Create an integer column. Optionally, minimum and maximum values can be provided.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • min (Integer) (defaults to: nil) —

    Minimum value

  • max (Integer) (defaults to: nil) —

    Maximum value

  • default (Integer) (defaults to: nil) —

    Default value. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnInteger) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/appwrite/services/tables_db.rb', line 1158

def create_integer_column(database_id:, table_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/integer'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        min: min,
        max: max,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnInteger
    )
end

#create_ip_column(database_id:, table_id:, key:, required:, default: nil, array: nil) ⇒ ColumnIp

Create IP address column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) (defaults to: nil) —

    Default value. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnIp) 


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/appwrite/services/tables_db.rb', line 1273

def create_ip_column(database_id:, table_id:, key:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/ip'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnIp
    )
end

#create_line_column(database_id:, table_id:, key:, required:, default: nil) ⇒ ColumnLine

Create a geometric line column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Array) (defaults to: nil) —

    Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.

Returns:

  • (ColumnLine) 


1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/appwrite/services/tables_db.rb', line 1380

def create_line_column(database_id:, table_id:, key:, required:, default: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/line'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnLine
    )
end

#create_operations(transaction_id:, operations: nil) ⇒ Transaction

Create multiple operations in a single transaction.

Parameters:

  • transaction_id (String) —

    Transaction ID.

  • operations (Array) (defaults to: nil) —

    Array of staged operations.

Returns:

  • (Transaction) 


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/appwrite/services/tables_db.rb', line 221

def create_operations(transaction_id:, operations: nil)
    api_path = '/tablesdb/transactions/{transactionId}/operations'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
        operations: operations,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#create_point_column(database_id:, table_id:, key:, required:, default: nil) ⇒ ColumnPoint

Create a geometric point column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Array) (defaults to: nil) —

    Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.

Returns:

  • (ColumnPoint) 


1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/appwrite/services/tables_db.rb', line 1481

def create_point_column(database_id:, table_id:, key:, required:, default: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/point'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnPoint
    )
end

#create_polygon_column(database_id:, table_id:, key:, required:, default: nil) ⇒ ColumnPolygon

Create a geometric polygon column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Array) (defaults to: nil) —

    Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.

Returns:

  • (ColumnPolygon) 


1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/appwrite/services/tables_db.rb', line 1582

def create_polygon_column(database_id:, table_id:, key:, required:, default: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/polygon'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnPolygon
    )
end

#create_relationship_column(database_id:, table_id:, related_table_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil) ⇒ ColumnRelationship

Create relationship column. [Learn more about relationship columns](appwrite.io/docs/databases-relationships#relationship-columns).

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • related_table_id (String) —

    Related Table ID.

  • type (RelationshipType) —

    Relation type

  • [] —

    two_way Is Two Way?

  • key (String) (defaults to: nil) —

    Column Key.

  • two_way_key (String) (defaults to: nil) —

    Two Way Column Key.

  • on_delete (RelationMutate) (defaults to: nil) —

    Constraints option

Returns:

  • (ColumnRelationship) 


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
 
# File 'lib/appwrite/services/tables_db.rb', line 1688

def create_relationship_column(database_id:, table_id:, related_table_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/relationship'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if related_table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "relatedTableId"')
    end

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    api_params = {
        relatedTableId: related_table_id,
        type: type,
        twoWay: two_way,
        key: key,
        twoWayKey: two_way_key,
        onDelete: on_delete,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnRelationship
    )
end

#create_row(database_id:, table_id:, row_id:, data:, permissions: nil, transaction_id: nil) ⇒ Row

Create a new Row. Before using this route, you should create a new table resource using either a [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable). Make sure to define columns before creating rows.

  • row_id (String) —

    Row ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • data (Hash) —

    Row data as JSON object.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](appwrite.io/docs/permissions).

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Row) 


2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
 
# File 'lib/appwrite/services/tables_db.rb', line 2316

def create_row(database_id:, table_id:, row_id:, data:, permissions: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    if data.nil?
      raise Appwrite::Exception.new('Missing required parameter: "data"')
    end

    api_params = {
        rowId: row_id,
        data: data,
        permissions: permissions,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Row
    )
end

#create_rows(database_id:, table_id:, rows:, transaction_id: nil) ⇒ RowList

Create new Rows. Before using this route, you should create a new table resource using either a [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable). Make sure to define columns before creating rows.

  • rows (Array) —

    Array of rows data as JSON objects.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (RowList) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/appwrite/services/tables_db.rb', line 2368

def create_rows(database_id:, table_id:, rows:, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if rows.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rows"')
    end

    api_params = {
        rows: rows,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::RowList
    )
end

#create_string_column(database_id:, table_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil) ⇒ ColumnString

Create a string column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • size (Integer) —

    Column size for text columns, in number of characters.

  • [] —

    required Is column required?

  • default (String) (defaults to: nil) —

    Default value for column when not provided. Cannot be set when column is required.

  • [] —

    array Is column an array?

  • [] —

    encrypt Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.

Returns:

  • (ColumnString) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/appwrite/services/tables_db.rb', line 1744

def create_string_column(database_id:, table_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/string'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if size.nil?
      raise Appwrite::Exception.new('Missing required parameter: "size"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        size: size,
        required: required,
        default: default,
        array: array,
        encrypt: encrypt,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnString
    )
end

#create_table(database_id:, table_id:, name:, permissions: nil, row_security: nil, enabled: nil) ⇒ Table

Create a new Table. Before using this route, you should create a new database resource using either a [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Unique Id. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • name (String) —

    Table name. Max length: 128 chars.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    row_security Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    enabled Is table enabled? When set to ‘disabled’, users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.

Returns:

  • (Table) 


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/appwrite/services/tables_db.rb', line 389

def create_table(database_id:, table_id:, name:, permissions: nil, row_security: nil, enabled: nil)
    api_path = '/tablesdb/{databaseId}/tables'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        tableId: table_id,
        name: name,
        permissions: permissions,
        rowSecurity: row_security,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Table
    )
end

#create_transaction(ttl: nil) ⇒ Transaction

Create a new transaction.

Parameters:

  • ttl (Integer) (defaults to: nil) —

    Seconds before the transaction expires.

Returns:

  • (Transaction) 


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/appwrite/services/tables_db.rb', line 106

def create_transaction(ttl: nil)
    api_path = '/tablesdb/transactions'

    api_params = {
        ttl: ttl,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#create_url_column(database_id:, table_id:, key:, required:, default: nil, array: nil) ⇒ ColumnUrl

Create a URL column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) (defaults to: nil) —

    Default value for column when not provided. Cannot be set when column is required.

  • [] —

    array Is column an array?

Returns:

  • (ColumnUrl) 


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
 
# File 'lib/appwrite/services/tables_db.rb', line 1861

def create_url_column(database_id:, table_id:, key:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/url'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnUrl
    )
end

#decrement_row_column(database_id:, table_id:, row_id:, column:, value: nil, min: nil, transaction_id: nil) ⇒ Row

Decrement a specific column of a row by a given value.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • row_id (String) —

    Row ID.

  • column (String) —

    Column key.

  • value (Float) (defaults to: nil) —

    Value to increment the column by. The value must be a number.

  • min (Float) (defaults to: nil) —

    Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Row) 


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
 
# File 'lib/appwrite/services/tables_db.rb', line 2728

def decrement_row_column(database_id:, table_id:, row_id:, column:, value: nil, min: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/decrement'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{rowId}', row_id)
        .gsub('{column}', column)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    if column.nil?
      raise Appwrite::Exception.new('Missing required parameter: "column"')
    end

    api_params = {
        value: value,
        min: min,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Row
    )
end

#delete(database_id:) ⇒ Object

Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.

Parameters:

  • database_id (String) —

    Database ID.

Returns:



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/appwrite/services/tables_db.rb', line 318

def delete(database_id:)
    api_path = '/tablesdb/{databaseId}'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_column(database_id:, table_id:, key:) ⇒ Object

Deletes a column.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

Returns:



2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
 
# File 'lib/appwrite/services/tables_db.rb', line 2005

def delete_column(database_id:, table_id:, key:)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_index(database_id:, table_id:, key:) ⇒ Object

Delete an index.

Parameters:

Returns:



2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
 
# File 'lib/appwrite/services/tables_db.rb', line 2229

def delete_index(database_id:, table_id:, key:)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/indexes/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_row(database_id:, table_id:, row_id:, transaction_id: nil) ⇒ Object

Delete a row by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • row_id (String) —

    Row ID.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:



2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
 
# File 'lib/appwrite/services/tables_db.rb', line 2683

def delete_row(database_id:, table_id:, row_id:, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{rowId}', row_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    api_params = {
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_rows(database_id:, table_id:, queries: nil, transaction_id: nil) ⇒ RowList

Bulk delete rows using queries, if no queries are passed then all rows are deleted.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (RowList) 


2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
 
# File 'lib/appwrite/services/tables_db.rb', line 2501

def delete_rows(database_id:, table_id:, queries: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
        queries: queries,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::RowList
    )
end

#delete_table(database_id:, table_id:) ⇒ Object

Delete a table by its unique ID. Only users with write permissions have access to delete this resource.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

Returns:



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/appwrite/services/tables_db.rb', line 515

def delete_table(database_id:, table_id:)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_transaction(transaction_id:) ⇒ Object

Delete a transaction by its unique ID.

Parameters:

  • transaction_id (String) —

    Transaction ID.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/appwrite/services/tables_db.rb', line 192

def delete_transaction(transaction_id:)
    api_path = '/tablesdb/transactions/{transactionId}'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#get(database_id:) ⇒ Database

Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.

Parameters:

  • database_id (String) —

    Database ID.

Returns:

  • (Database) 


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/appwrite/services/tables_db.rb', line 252

def get(database_id:)
    api_path = '/tablesdb/{databaseId}'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Database
    )
end

#get_column(database_id:, table_id:, key:) ⇒ Object

Get column by ID.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

Returns:



1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
 
# File 'lib/appwrite/services/tables_db.rb', line 1966

def get_column(database_id:, table_id:, key:)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#get_index(database_id:, table_id:, key:) ⇒ ColumnIndex

Get index by ID.

Parameters:

Returns:

  • (ColumnIndex) 


2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
 
# File 'lib/appwrite/services/tables_db.rb', line 2189

def get_index(database_id:, table_id:, key:)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/indexes/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnIndex
    )
end

#get_row(database_id:, table_id:, row_id:, queries: nil, transaction_id: nil) ⇒ Row

Get a row by its unique ID. This endpoint response returns a JSON object with the row data.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • row_id (String) —

    Row ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID to read uncommitted changes within the transaction.

Returns:

  • (Row) 


2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
 
# File 'lib/appwrite/services/tables_db.rb', line 2542

def get_row(database_id:, table_id:, row_id:, queries: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{rowId}', row_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    api_params = {
        queries: queries,
        transactionId: transaction_id,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Row
    )
end

#get_table(database_id:, table_id:) ⇒ Table

Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

Returns:

  • (Table) 


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/appwrite/services/tables_db.rb', line 433

def get_table(database_id:, table_id:)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Table
    )
end

#get_transaction(transaction_id:) ⇒ Transaction

Get a transaction by its unique ID.

Parameters:

  • transaction_id (String) —

    Transaction ID.

Returns:

  • (Transaction) 


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/appwrite/services/tables_db.rb', line 131

def get_transaction(transaction_id:)
    api_path = '/tablesdb/transactions/{transactionId}'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#increment_row_column(database_id:, table_id:, row_id:, column:, value: nil, max: nil, transaction_id: nil) ⇒ Row

Increment a specific column of a row by a given value.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • row_id (String) —

    Row ID.

  • column (String) —

    Column key.

  • value (Float) (defaults to: nil) —

    Value to increment the column by. The value must be a number.

  • max (Float) (defaults to: nil) —

    Maximum value for the column. If the current value is greater than this value, an error will be thrown.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Row) 


2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
 
# File 'lib/appwrite/services/tables_db.rb', line 2781

def increment_row_column(database_id:, table_id:, row_id:, column:, value: nil, max: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/increment'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{rowId}', row_id)
        .gsub('{column}', column)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    if column.nil?
      raise Appwrite::Exception.new('Missing required parameter: "column"')
    end

    api_params = {
        value: value,
        max: max,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Row
    )
end

#list(queries: nil, search: nil, total: nil) ⇒ DatabaseList

Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (DatabaseList) 


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/appwrite/services/tables_db.rb', line 18

def list(queries: nil, search: nil, total: nil)
    api_path = '/tablesdb'

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DatabaseList
    )
end

#list_columns(database_id:, table_id:, queries: nil, total: nil) ⇒ ColumnList

List columns in the table.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (ColumnList) 


551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/appwrite/services/tables_db.rb', line 551

def list_columns(database_id:, table_id:, queries: nil, total: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnList
    )
end

#list_indexes(database_id:, table_id:, queries: nil, total: nil) ⇒ ColumnIndexList

List indexes on the table.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (ColumnIndexList) 


2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/appwrite/services/tables_db.rb', line 2093

def list_indexes(database_id:, table_id:, queries: nil, total: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/indexes'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnIndexList
    )
end

#list_rows(database_id:, table_id:, queries: nil, transaction_id: nil, total: nil) ⇒ RowList

Get a list of all the user’s rows in a given table. You can use the query params to filter your results.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/products/databases/tables#create-table).

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID to read uncommitted changes within the transaction.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (RowList) 


2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
 
# File 'lib/appwrite/services/tables_db.rb', line 2272

def list_rows(database_id:, table_id:, queries: nil, transaction_id: nil, total: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
        queries: queries,
        transactionId: transaction_id,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::RowList
    )
end

#list_tables(database_id:, queries: nil, search: nil, total: nil) ⇒ TableList

Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.

Parameters:

  • database_id (String) —

    Database ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (TableList) 


350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/appwrite/services/tables_db.rb', line 350

def list_tables(database_id:, queries: nil, search: nil, total: nil)
    api_path = '/tablesdb/{databaseId}/tables'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::TableList
    )
end

#list_transactions(queries: nil) ⇒ TransactionList

List transactions across all databases.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries).

Returns:

  • (TransactionList) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/appwrite/services/tables_db.rb', line 82

def list_transactions(queries: nil)
    api_path = '/tablesdb/transactions'

    api_params = {
        queries: queries,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::TransactionList
    )
end

#update(database_id:, name:, enabled: nil) ⇒ Database

Update a database by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • name (String) —

    Database name. Max length: 128 chars.

  • [] —

    enabled Is database enabled? When set to ‘disabled’, users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.

Returns:

  • (Database) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/appwrite/services/tables_db.rb', line 282

def update(database_id:, name:, enabled: nil)
    api_path = '/tablesdb/{databaseId}'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        name: name,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Database
    )
end

#update_boolean_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnBoolean

Update a boolean column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • [] —

    default Default value for column when not provided. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnBoolean) 


644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/appwrite/services/tables_db.rb', line 644

def update_boolean_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/boolean/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnBoolean
    )
end

#update_datetime_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnDatetime

Update a date time column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) —

    Default value for column when not provided. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnDatetime) 


751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/appwrite/services/tables_db.rb', line 751

def update_datetime_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/datetime/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnDatetime
    )
end

#update_email_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnEmail

Update an email column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) —

    Default value for column when not provided. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnEmail) 


860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/appwrite/services/tables_db.rb', line 860

def update_email_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/email/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnEmail
    )
end

#update_enum_column(database_id:, table_id:, key:, elements:, required:, default:, new_key: nil) ⇒ ColumnEnum

Update an enum column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • elements (Array) —

    Updated list of enum values.

  • [] —

    required Is column required?

  • default (String) —

    Default value for column when not provided. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnEnum) 


976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/appwrite/services/tables_db.rb', line 976

def update_enum_column(database_id:, table_id:, key:, elements:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/enum/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if elements.nil?
      raise Appwrite::Exception.new('Missing required parameter: "elements"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        elements: elements,
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnEnum
    )
end

#update_float_column(database_id:, table_id:, key:, required:, default:, min: nil, max: nil, new_key: nil) ⇒ ColumnFloat

Update a float column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Float) —

    Default value. Cannot be set when required.

  • min (Float) (defaults to: nil) —

    Minimum value

  • max (Float) (defaults to: nil) —

    Maximum value

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnFloat) 


1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/appwrite/services/tables_db.rb', line 1097

def update_float_column(database_id:, table_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/float/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        min: min,
        max: max,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnFloat
    )
end

#update_integer_column(database_id:, table_id:, key:, required:, default:, min: nil, max: nil, new_key: nil) ⇒ ColumnInteger

Update an integer column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Integer) —

    Default value. Cannot be set when column is required.

  • min (Integer) (defaults to: nil) —

    Minimum value

  • max (Integer) (defaults to: nil) —

    Maximum value

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnInteger) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/appwrite/services/tables_db.rb', line 1215

def update_integer_column(database_id:, table_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/integer/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        min: min,
        max: max,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnInteger
    )
end

#update_ip_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnIp

Update an ip column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) —

    Default value. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnIp) 


1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/appwrite/services/tables_db.rb', line 1326

def update_ip_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/ip/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnIp
    )
end

#update_line_column(database_id:, table_id:, key:, required:, default: nil, new_key: nil) ⇒ ColumnLine

Update a line column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Array) (defaults to: nil) —

    Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnLine) 


1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/appwrite/services/tables_db.rb', line 1431

def update_line_column(database_id:, table_id:, key:, required:, default: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/line/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnLine
    )
end

#update_point_column(database_id:, table_id:, key:, required:, default: nil, new_key: nil) ⇒ ColumnPoint

Update a point column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Array) (defaults to: nil) —

    Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnPoint) 


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
 
# File 'lib/appwrite/services/tables_db.rb', line 1532

def update_point_column(database_id:, table_id:, key:, required:, default: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/point/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnPoint
    )
end

#update_polygon_column(database_id:, table_id:, key:, required:, default: nil, new_key: nil) ⇒ ColumnPolygon

Update a polygon column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the TablesDB service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (Array) (defaults to: nil) —

    Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnPolygon) 


1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'lib/appwrite/services/tables_db.rb', line 1633

def update_polygon_column(database_id:, table_id:, key:, required:, default: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/polygon/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnPolygon
    )
end

#update_relationship_column(database_id:, table_id:, key:, on_delete: nil, new_key: nil) ⇒ ColumnRelationship

Update relationship column. [Learn more about relationship columns](appwrite.io/docs/databases-relationships#relationship-columns).

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • on_delete (RelationMutate) (defaults to: nil) —

    Constraints option

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnRelationship) 


2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'lib/appwrite/services/tables_db.rb', line 2049

def update_relationship_column(database_id:, table_id:, key:, on_delete: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/{key}/relationship'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
        onDelete: on_delete,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnRelationship
    )
end

#update_row(database_id:, table_id:, row_id:, data: nil, permissions: nil, transaction_id: nil) ⇒ Row

Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • row_id (String) —

    Row ID.

  • data (Hash) (defaults to: nil) —

    Row data as JSON object. Include only columns and value pairs to be updated.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](appwrite.io/docs/permissions).

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Row) 


2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
 
# File 'lib/appwrite/services/tables_db.rb', line 2638

def update_row(database_id:, table_id:, row_id:, data: nil, permissions: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{rowId}', row_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    api_params = {
        data: data,
        permissions: permissions,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Row
    )
end

#update_rows(database_id:, table_id:, data: nil, queries: nil, transaction_id: nil) ⇒ RowList

Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • data (Hash) (defaults to: nil) —

    Row data as JSON object. Include only column and value pairs to be updated.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (RowList) 


2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/appwrite/services/tables_db.rb', line 2460

def update_rows(database_id:, table_id:, data: nil, queries: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    api_params = {
        data: data,
        queries: queries,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::RowList
    )
end

#update_string_column(database_id:, table_id:, key:, required:, default:, size: nil, new_key: nil) ⇒ ColumnString

Update a string column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID. You can create a new table using the Database service [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) —

    Default value for column when not provided. Cannot be set when column is required.

  • size (Integer) (defaults to: nil) —

    Maximum size of the string column.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnString) 


1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
 
# File 'lib/appwrite/services/tables_db.rb', line 1804

def update_string_column(database_id:, table_id:, key:, required:, default:, size: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/string/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        size: size,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnString
    )
end

#update_table(database_id:, table_id:, name:, permissions: nil, row_security: nil, enabled: nil) ⇒ Table

Update a table by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • name (String) —

    Table name. Max length: 128 chars.

  • permissions (Array) (defaults to: nil) —

    An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    row_security Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    enabled Is table enabled? When set to ‘disabled’, users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.

Returns:

  • (Table) 


471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/appwrite/services/tables_db.rb', line 471

def update_table(database_id:, table_id:, name:, permissions: nil, row_security: nil, enabled: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        name: name,
        permissions: permissions,
        rowSecurity: row_security,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Table
    )
end

#update_transaction(transaction_id:, commit: nil, rollback: nil) ⇒ Transaction

Update a transaction, to either commit or roll back its operations.

Parameters:

  • transaction_id (String) —

    Transaction ID.

  • [] —

    commit Commit transaction?

  • [] —

    rollback Rollback transaction?

Returns:

  • (Transaction) 


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/appwrite/services/tables_db.rb', line 161

def update_transaction(transaction_id:, commit: nil, rollback: nil)
    api_path = '/tablesdb/transactions/{transactionId}'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
        commit: commit,
        rollback: rollback,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#update_url_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnUrl

Update an url column. Changing the ‘default` value will not update already existing rows.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

  • [] —

    required Is column required?

  • default (String) —

    Default value for column when not provided. Cannot be set when column is required.

  • new_key (String) (defaults to: nil) —

    New Column Key.

Returns:

  • (ColumnUrl) 


1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/appwrite/services/tables_db.rb', line 1914

def update_url_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/url/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ColumnUrl
    )
end

#upsert_row(database_id:, table_id:, row_id:, data: nil, permissions: nil, transaction_id: nil) ⇒ Row

Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • row_id (String) —

    Row ID.

  • data (Hash) (defaults to: nil) —

    Row data as JSON object. Include all required columns of the row to be created or updated.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](appwrite.io/docs/permissions).

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Row) 


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
 
# File 'lib/appwrite/services/tables_db.rb', line 2590

def upsert_row(database_id:, table_id:, row_id:, data: nil, permissions: nil, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)
        .gsub('{rowId}', row_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if row_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rowId"')
    end

    api_params = {
        data: data,
        permissions: permissions,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Row
    )
end

#upsert_rows(database_id:, table_id:, rows:, transaction_id: nil) ⇒ RowList

Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • rows (Array) —

    Array of row data as JSON objects. May contain partial rows.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (RowList) 


2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
 
# File 'lib/appwrite/services/tables_db.rb', line 2415

def upsert_rows(database_id:, table_id:, rows:, transaction_id: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if table_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "tableId"')
    end

    if rows.nil?
      raise Appwrite::Exception.new('Missing required parameter: "rows"')
    end

    api_params = {
        rows: rows,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::RowList
    )
end