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) 


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
76
77
78
79
 
# File 'lib/appwrite/services/tables_db.rb', line 49

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#create_big_int_column(database_id:, table_id:, key:, required:, min: nil, max: nil, default: nil, array: nil) ⇒ ColumnBigint

Create a bigint 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:

  • (ColumnBigint) 


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
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
 
# File 'lib/appwrite/services/tables_db.rb', line 627

def create_big_int_column(database_id:, table_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/bigint'
        .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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


746
747
748
749
750
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
 
# File 'lib/appwrite/services/tables_db.rb', line 746

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


857
858
859
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
 
# File 'lib/appwrite/services/tables_db.rb', line 857

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


969
970
971
972
973
974
975
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
 
# File 'lib/appwrite/services/tables_db.rb', line 969

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1083

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1210
1211
1212
1213
1214
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1210

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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 (TablesDBIndexType) —

    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) 


2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
 
# File 'lib/appwrite/services/tables_db.rb', line 2878

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
1370
1371
1372
1373
1374
1375
 
# File 'lib/appwrite/services/tables_db.rb', line 1332

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/appwrite/services/tables_db.rb', line 1451

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/appwrite/services/tables_db.rb', line 1562

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#create_longtext_column(database_id:, table_id:, key:, required:, default: nil, array: nil, encrypt: nil) ⇒ ColumnLongtext

Create a longtext 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 (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:

  • (ColumnLongtext) 


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1670

def create_longtext_column(database_id:, table_id:, key:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/longtext'
        .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,
        encrypt: encrypt,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#create_mediumtext_column(database_id:, table_id:, key:, required:, default: nil, array: nil, encrypt: nil) ⇒ ColumnMediumtext

Create a mediumtext 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 (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:

  • (ColumnMediumtext) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/appwrite/services/tables_db.rb', line 1785

def create_mediumtext_column(database_id:, table_id:, key:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext'
        .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,
        encrypt: encrypt,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/appwrite/services/tables_db.rb', line 235

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
 
# File 'lib/appwrite/services/tables_db.rb', line 1897

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2002
2003
2004
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
2037
2038
2039
2040
2041
2042
 
# File 'lib/appwrite/services/tables_db.rb', line 2002

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'lib/appwrite/services/tables_db.rb', line 2112

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
 
# File 'lib/appwrite/services/tables_db.rb', line 3068

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
 
# File 'lib/appwrite/services/tables_db.rb', line 3122

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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

Deprecated.

This API has been deprecated since 1.9.0. Please use ‘TablesDB.createTextColumn` instead.

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) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
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 2173

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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, columns: nil, indexes: 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.

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

    Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.

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

    Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).

Returns:

  • (Table) 


411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/appwrite/services/tables_db.rb', line 411

def create_table(database_id:, table_id:, name:, permissions: nil, row_security: nil, enabled: nil, columns: nil, indexes: 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,
        columns: columns,
        indexes: indexes,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#create_text_column(database_id:, table_id:, key:, required:, default: nil, array: nil, encrypt: nil) ⇒ ColumnText

Create a text 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 (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:

  • (ColumnText) 


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
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
 
# File 'lib/appwrite/services/tables_db.rb', line 2298

def create_text_column(database_id:, table_id:, key:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/text'
        .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,
        encrypt: encrypt,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#create_transaction(ttl: nil) ⇒ Transaction

Create a new transaction.

Parameters:

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

    Seconds before the transaction expires.

Returns:

  • (Transaction) 


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/appwrite/services/tables_db.rb', line 112

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

    api_params = {
        ttl: ttl,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2412
2413
2414
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
2449
2450
2451
2452
2453
 
# File 'lib/appwrite/services/tables_db.rb', line 2412

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#create_varchar_column(database_id:, table_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil) ⇒ ColumnVarchar

Create a varchar 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 varchar columns, in number of characters. Maximum size is 16381.

  • [] —

    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:

  • (ColumnVarchar) 


2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
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
 
# File 'lib/appwrite/services/tables_db.rb', line 2527

def create_varchar_column(database_id:, table_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/varchar'
        .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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
 
# File 'lib/appwrite/services/tables_db.rb', line 3498

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/appwrite/services/tables_db.rb', line 334

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



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
2769
2770
2771
2772
2773
2774
 
# File 'lib/appwrite/services/tables_db.rb', line 2741

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
 
# File 'lib/appwrite/services/tables_db.rb', line 2975

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
 
# File 'lib/appwrite/services/tables_db.rb', line 3451

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
 
# File 'lib/appwrite/services/tables_db.rb', line 3261

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/appwrite/services/tables_db.rb', line 543

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/appwrite/services/tables_db.rb', line 204

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/appwrite/services/tables_db.rb', line 268

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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:) ⇒ ColumnBoolean, ...

Get column by ID.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

  • key (String) —

    Column Key.

Returns:

  • (ColumnBoolean, ColumnInteger, ColumnFloat, ColumnEmail, ColumnEnum, ColumnUrl, ColumnIp, ColumnDatetime, ColumnRelationship, ColumnString)

Raises:



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
2674
2675
2676
2677
2678
2679
2680
2681
2682
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
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
 
# File 'lib/appwrite/services/tables_db.rb', line 2644

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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

    unless response.is_a?(Hash)
        raise Exception, "Expected object response when hydrating a response model"
    end

    if response['type'] == 'string' && response['format'] == 'email'

        return Models::ColumnEmail.from(map: response)
    end

    if response['type'] == 'string' && response['format'] == 'enum'

        return Models::ColumnEnum.from(map: response)
    end

    if response['type'] == 'string' && response['format'] == 'url'

        return Models::ColumnUrl.from(map: response)
    end

    if response['type'] == 'string' && response['format'] == 'ip'

        return Models::ColumnIp.from(map: response)
    end

    if response['type'] == 'boolean'

        return Models::ColumnBoolean.from(map: response)
    end

    if response['type'] == 'integer'

        return Models::ColumnInteger.from(map: response)
    end

    if response['type'] == 'double'

        return Models::ColumnFloat.from(map: response)
    end

    if response['type'] == 'datetime'

        return Models::ColumnDatetime.from(map: response)
    end

    if response['type'] == 'relationship'

        return Models::ColumnRelationship.from(map: response)
    end

    if response['type'] == 'string'

        return Models::ColumnString.from(map: response)
    end

    raise Exception, "Unable to match response to any expected response model"

end

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

Get index by ID.

Parameters:

Returns:

  • (ColumnIndex) 


2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
 
# File 'lib/appwrite/services/tables_db.rb', line 2933

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
 
# File 'lib/appwrite/services/tables_db.rb', line 3304

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/appwrite/services/tables_db.rb', line 459

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/appwrite/services/tables_db.rb', line 139

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
 
# File 'lib/appwrite/services/tables_db.rb', line 3553

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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
38
39
 
# 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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/appwrite/services/tables_db.rb', line 581

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
 
# File 'lib/appwrite/services/tables_db.rb', line 2833

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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, ttl: 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.

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

    TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).

Returns:

  • (RowList) 


3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'lib/appwrite/services/tables_db.rb', line 3021

def list_rows(database_id:, table_id:, queries: nil, transaction_id: nil, total: nil, ttl: 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,
        ttl: ttl,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/appwrite/services/tables_db.rb', line 368

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/appwrite/services/tables_db.rb', line 86

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

    api_params = {
        queries: queries,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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

end

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

Update a database by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

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

    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) 


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/appwrite/services/tables_db.rb', line 300

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

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

    api_params = {
        name: name,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#update_big_int_column(database_id:, table_id:, key:, required:, default:, min: nil, max: nil, new_key: nil) ⇒ ColumnBigint

Update a bigint 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:

  • (ColumnBigint) 


686
687
688
689
690
691
692
693
694
695
696
697
698
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
 
# File 'lib/appwrite/services/tables_db.rb', line 686

def update_big_int_column(database_id:, table_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/bigint/{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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


800
801
802
803
804
805
806
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
 
# File 'lib/appwrite/services/tables_db.rb', line 800

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


911
912
913
914
915
916
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
 
# File 'lib/appwrite/services/tables_db.rb', line 911

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1024

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1144

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1269
1270
1271
1272
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
1313
1314
1315
1316
 
# File 'lib/appwrite/services/tables_db.rb', line 1269

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/appwrite/services/tables_db.rb', line 1391

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'lib/appwrite/services/tables_db.rb', line 1506

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'lib/appwrite/services/tables_db.rb', line 1615

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#update_longtext_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnLongtext

Update a longtext 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.

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

    New Column Key.

Returns:

  • (ColumnLongtext) 


1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1726

def update_longtext_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/longtext/{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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#update_mediumtext_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnMediumtext

Update a mediumtext 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.

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

    New Column Key.

Returns:

  • (ColumnMediumtext) 


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1841

def update_mediumtext_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext/{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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
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
 
# File 'lib/appwrite/services/tables_db.rb', line 1950

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
 
# File 'lib/appwrite/services/tables_db.rb', line 2055

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
2822
2823
 
# File 'lib/appwrite/services/tables_db.rb', line 2787

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/appwrite/services/tables_db.rb', line 3404

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
 
# File 'lib/appwrite/services/tables_db.rb', line 3218

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateTextColumn` instead.

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) 


2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
 
# File 'lib/appwrite/services/tables_db.rb', line 2238

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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: nil, permissions: nil, row_security: nil, enabled: nil, purge: nil) ⇒ Table

Update a table by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • table_id (String) —

    Table ID.

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

    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.

  • [] —

    purge When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.

Returns:

  • (Table) 


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/appwrite/services/tables_db.rb', line 500

def update_table(database_id:, table_id:, name: nil, permissions: nil, row_security: nil, enabled: nil, purge: 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

    api_params = {
        name: name,
        permissions: permissions,
        rowSecurity: row_security,
        enabled: enabled,
        purge: purge,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#update_text_column(database_id:, table_id:, key:, required:, default:, new_key: nil) ⇒ ColumnText

Update a text 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.

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

    New Column Key.

Returns:

  • (ColumnText) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
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
 
# File 'lib/appwrite/services/tables_db.rb', line 2354

def update_text_column(database_id:, table_id:, key:, required:, default:, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/text/{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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/appwrite/services/tables_db.rb', line 171

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
 
# File 'lib/appwrite/services/tables_db.rb', line 2467

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end

#update_varchar_column(database_id:, table_id:, key:, required:, default:, size: nil, new_key: nil) ⇒ ColumnVarchar

Update a varchar 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 varchar column.

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

    New Column Key.

Returns:

  • (ColumnVarchar) 


2589
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
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
 
# File 'lib/appwrite/services/tables_db.rb', line 2589

def update_varchar_column(database_id:, table_id:, key:, required:, default:, size: nil, new_key: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/varchar/{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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

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) 


3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/appwrite/services/tables_db.rb', line 3354

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
 
# File 'lib/appwrite/services/tables_db.rb', line 3171

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end