-
Notifications
You must be signed in to change notification settings - Fork 54
/
database.go
1186 lines (971 loc) · 48 KB
/
database.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
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
451
452
453
454
455
456
457
458
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
488
489
490
491
492
493
494
495
496
497
498
499
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
535
536
537
538
539
540
541
542
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
572
573
574
575
576
577
578
579
580
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
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
734
735
736
737
738
739
740
741
742
743
744
745
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
788
789
790
791
792
793
794
795
796
797
798
799
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
846
847
848
849
850
851
852
853
854
855
856
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
899
900
901
902
903
904
905
906
907
908
909
910
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
957
958
959
960
961
962
963
964
965
966
967
968
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
package govultr
import (
"context"
"fmt"
"net/http"
"github.com/google/go-querystring/query"
)
const databasePath = "/v2/databases"
// DatabaseService is the interface to interact with the Database endpoints on the Vultr API
// Link: https://www.vultr.com/api/#tag/managed-databases
type DatabaseService interface {
ListPlans(ctx context.Context, options *DBPlanListOptions) ([]DatabasePlan, *Meta, *http.Response, error)
List(ctx context.Context, options *DBListOptions) ([]Database, *Meta, *http.Response, error)
Create(ctx context.Context, databaseReq *DatabaseCreateReq) (*Database, *http.Response, error)
Get(ctx context.Context, databaseID string) (*Database, *http.Response, error)
Update(ctx context.Context, databaseID string, databaseReq *DatabaseUpdateReq) (*Database, *http.Response, error)
Delete(ctx context.Context, databaseID string) error
GetUsage(ctx context.Context, databaseID string) (*DatabaseUsage, *http.Response, error)
ListUsers(ctx context.Context, databaseID string) ([]DatabaseUser, *Meta, *http.Response, error)
CreateUser(ctx context.Context, databaseID string, databaseUserReq *DatabaseUserCreateReq) (*DatabaseUser, *http.Response, error)
GetUser(ctx context.Context, databaseID string, username string) (*DatabaseUser, *http.Response, error)
UpdateUser(ctx context.Context, databaseID string, username string, databaseUserReq *DatabaseUserUpdateReq) (*DatabaseUser, *http.Response, error) //nolint:lll
DeleteUser(ctx context.Context, databaseID string, username string) error
UpdateUserACL(ctx context.Context, databaseID string, username string, databaseUserACLReq *DatabaseUserACLReq) (*DatabaseUser, *http.Response, error) //nolint:lll
ListDBs(ctx context.Context, databaseID string) ([]DatabaseDB, *Meta, *http.Response, error)
CreateDB(ctx context.Context, databaseID string, databaseDBReq *DatabaseDBCreateReq) (*DatabaseDB, *http.Response, error)
GetDB(ctx context.Context, databaseID string, dbname string) (*DatabaseDB, *http.Response, error)
DeleteDB(ctx context.Context, databaseID string, dbname string) error
ListMaintenanceUpdates(ctx context.Context, databaseID string) ([]string, *http.Response, error)
StartMaintenance(ctx context.Context, databaseID string) (string, *http.Response, error)
ListServiceAlerts(ctx context.Context, databaseID string, databaseAlertsReq *DatabaseListAlertsReq) ([]DatabaseAlert, *http.Response, error) //nolint:lll
GetMigrationStatus(ctx context.Context, databaseID string) (*DatabaseMigration, *http.Response, error)
StartMigration(ctx context.Context, databaseID string, databaseMigrationReq *DatabaseMigrationStartReq) (*DatabaseMigration, *http.Response, error) //nolint:lll
DetachMigration(ctx context.Context, databaseID string) error
AddReadOnlyReplica(ctx context.Context, databaseID string, databaseReplicaReq *DatabaseAddReplicaReq) (*Database, *http.Response, error)
PromoteReadReplica(ctx context.Context, databaseID string) error
GetBackupInformation(ctx context.Context, databaseID string) (*DatabaseBackups, *http.Response, error)
RestoreFromBackup(ctx context.Context, databaseID string, databaseRestoreReq *DatabaseBackupRestoreReq) (*Database, *http.Response, error)
Fork(ctx context.Context, databaseID string, databaseForkReq *DatabaseForkReq) (*Database, *http.Response, error)
ListConnectionPools(ctx context.Context, databaseID string) (*DatabaseConnections, []DatabaseConnectionPool, *Meta, *http.Response, error)
CreateConnectionPool(ctx context.Context, databaseID string, databaseConnectionPoolReq *DatabaseConnectionPoolCreateReq) (*DatabaseConnectionPool, *http.Response, error) //nolint:lll
GetConnectionPool(ctx context.Context, databaseID string, poolName string) (*DatabaseConnectionPool, *http.Response, error)
UpdateConnectionPool(ctx context.Context, databaseID string, poolName string, databaseConnectionPoolReq *DatabaseConnectionPoolUpdateReq) (*DatabaseConnectionPool, *http.Response, error) //nolint:lll
DeleteConnectionPool(ctx context.Context, databaseID string, poolName string) error
ListAdvancedOptions(ctx context.Context, databaseID string) (*DatabaseAdvancedOptions, []AvailableOption, *http.Response, error)
UpdateAdvancedOptions(ctx context.Context, databaseID string, databaseAdvancedOptionsReq *DatabaseAdvancedOptions) (*DatabaseAdvancedOptions, []AvailableOption, *http.Response, error) //nolint:lll
ListAvailableVersions(ctx context.Context, databaseID string) ([]string, *http.Response, error)
StartVersionUpgrade(ctx context.Context, databaseID string, databaseVersionUpgradeReq *DatabaseVersionUpgradeReq) (string, *http.Response, error) //nolint:lll
}
// DatabaseServiceHandler handles interaction with the server methods for the Vultr API
type DatabaseServiceHandler struct {
client *Client
}
// DBPlanListOptions handles GET request parameters for the ListPlans endpoint
type DBPlanListOptions struct {
Engine string `url:"engine,omitempty"`
Nodes int `url:"nodes,omitempty"`
Region string `url:"region,omitempty"`
}
// DatabasePlan represents a Managed Database plan
type DatabasePlan struct {
ID string `json:"id"`
NumberOfNodes int `json:"number_of_nodes"`
Type string `json:"type"`
VCPUCount int `json:"vcpu_count"`
RAM int `json:"ram"`
Disk int `json:"disk"`
MonthlyCost int `json:"monthly_cost"`
SupportedEngines SupportedEngines `json:"supported_engines"`
MaxConnections *MaxConnections `json:"max_connections,omitempty"`
Locations []string `json:"locations"`
}
// SupportedEngines represents an object containing supported database engine types for Managed Database plans
type SupportedEngines struct {
MySQL *bool `json:"mysql"`
PG *bool `json:"pg"`
Redis *bool `json:"redis"`
}
// MaxConnections represents an object containing the maximum number of connections by engine type for Managed Database plans
type MaxConnections struct {
MySQL int `json:"mysql,omitempty"`
PG int `json:"pg,omitempty"`
}
// databasePlansBase holds the entire ListPlans API response
type databasePlansBase struct {
DatabasePlans []DatabasePlan `json:"plans"`
Meta *Meta `json:"meta"`
}
// DBListOptions handles GET request parameters for the List endpoint
type DBListOptions struct {
Label string `url:"label,omitempty"`
Tag string `url:"tag,omitempty"`
Region string `url:"region,omitempty"`
}
// Database represents a Managed Database subscription
type Database struct {
ID string `json:"id"`
DateCreated string `json:"date_created"`
Plan string `json:"plan"`
PlanDisk int `json:"plan_disk"`
PlanRAM int `json:"plan_ram"`
PlanVCPUs int `json:"plan_vcpus"`
PlanReplicas int `json:"plan_replicas"`
Region string `json:"region"`
DatabaseEngine string `json:"database_engine"`
DatabaseEngineVersion string `json:"database_engine_version"`
VPCID string `json:"vpc_id"`
Status string `json:"status"`
Label string `json:"label"`
Tag string `json:"tag"`
DBName string `json:"dbname,omitempty"`
FerretDBCredentials *FerretDBCredentials `json:"ferretdb_credentials,omitempty"`
Host string `json:"host"`
PublicHost string `json:"public_host,omitempty"`
User string `json:"user"`
Password string `json:"password"`
Port string `json:"port"`
MaintenanceDOW string `json:"maintenance_dow"`
MaintenanceTime string `json:"maintenance_time"`
LatestBackup string `json:"latest_backup"`
TrustedIPs []string `json:"trusted_ips"`
MySQLSQLModes []string `json:"mysql_sql_modes,omitempty"`
MySQLRequirePrimaryKey *bool `json:"mysql_require_primary_key,omitempty"`
MySQLSlowQueryLog *bool `json:"mysql_slow_query_log,omitempty"`
MySQLLongQueryTime int `json:"mysql_long_query_time,omitempty"`
PGAvailableExtensions []PGExtension `json:"pg_available_extensions,omitempty"`
RedisEvictionPolicy string `json:"redis_eviction_policy,omitempty"`
ClusterTimeZone string `json:"cluster_time_zone,omitempty"`
ReadReplicas []Database `json:"read_replicas,omitempty"`
}
// FerretDBCredentials represents connection details and IP address information for FerretDB engine type subscriptions
type FerretDBCredentials struct {
Host string `json:"host"`
Port int `json:"port"`
User string `json:"user"`
Password string `json:"password"`
PublicIP string `json:"public_ip"`
PrivateIP string `json:"private_ip,omitempty"`
}
// PGExtension represents an object containing extension name and version information
type PGExtension struct {
Name string `json:"name"`
Versions []string `json:"versions,omitempty"`
}
// databasesBase holds the entire List API response
type databasesBase struct {
Databases []Database `json:"databases"`
Meta *Meta `json:"meta"`
}
// databaseBase holds the entire Get API response
type databaseBase struct {
Database *Database `json:"database"`
}
// DatabaseCreateReq struct used to create a database.
type DatabaseCreateReq struct {
DatabaseEngine string `json:"database_engine,omitempty"`
DatabaseEngineVersion string `json:"database_engine_version,omitempty"`
Region string `json:"region,omitempty"`
Plan string `json:"plan,omitempty"`
Label string `json:"label,omitempty"`
Tag string `json:"tag,omitempty"`
VPCID string `json:"vpc_id,omitempty"`
MaintenanceDOW string `json:"maintenance_dow,omitempty"`
MaintenanceTime string `json:"maintenance_time,omitempty"`
TrustedIPs []string `json:"trusted_ips,omitempty"`
MySQLSQLModes []string `json:"mysql_sql_modes,omitempty"`
MySQLRequirePrimaryKey *bool `json:"mysql_require_primary_key,omitempty"`
MySQLSlowQueryLog *bool `json:"mysql_slow_query_log,omitempty"`
MySQLLongQueryTime int `json:"mysql_long_query_time,omitempty"`
RedisEvictionPolicy string `json:"redis_eviction_policy,omitempty"`
}
// DatabaseUpdateReq struct used to update a dataase.
type DatabaseUpdateReq struct {
Region string `json:"region,omitempty"`
Plan string `json:"plan,omitempty"`
Label string `json:"label,omitempty"`
Tag string `json:"tag,omitempty"`
VPCID *string `json:"vpc_id,omitempty"`
MaintenanceDOW string `json:"maintenance_dow,omitempty"`
MaintenanceTime string `json:"maintenance_time,omitempty"`
ClusterTimeZone string `json:"cluster_time_zone,omitempty"`
TrustedIPs []string `json:"trusted_ips,omitempty"`
MySQLSQLModes []string `json:"mysql_sql_modes,omitempty"`
MySQLRequirePrimaryKey *bool `json:"mysql_require_primary_key,omitempty"`
MySQLSlowQueryLog *bool `json:"mysql_slow_query_log,omitempty"`
MySQLLongQueryTime int `json:"mysql_long_query_time,omitempty"`
RedisEvictionPolicy string `json:"redis_eviction_policy,omitempty"`
}
// DatabaseUsage represents disk, memory, and CPU usage for a Managed Database
type DatabaseUsage struct {
Disk DatabaseDiskUsage `json:"disk"`
Memory DatabaseMemoryUsage `json:"memory"`
CPU DatabaseCPUUsage `json:"cpu"`
}
// DatabaseDiskUsage represents disk usage details for a Managed Database
type DatabaseDiskUsage struct {
CurrentGB float32 `json:"current_gb"`
MaxGB int `json:"max_gb"`
Percentage float32 `json:"percentage"`
}
// DatabaseMemoryUsage represents memory usage details for a Managed Database
type DatabaseMemoryUsage struct {
CurrentMB float32 `json:"current_mb"`
MaxMB int `json:"max_mb"`
Percentage float32 `json:"percentage"`
}
// DatabaseCPUUsage represents average CPU usage for a Managed Database
type DatabaseCPUUsage struct {
Percentage float32 `json:"percentage"`
}
// databaseUsageBase represents a usage details API response for a Managed Database
type databaseUsageBase struct {
Usage *DatabaseUsage `json:"usage"`
}
// DatabaseUser represents a user within a Managed Database cluster
type DatabaseUser struct {
Username string `json:"username"`
Password string `json:"password"`
Encryption string `json:"encryption,omitempty"`
AccessControl *DatabaseUserACL `json:"access_control,omitempty"`
}
// DatabaseUserACL represents an access control configuration for a user within a Redis Managed Database cluster
type DatabaseUserACL struct {
RedisACLCategories []string `json:"redis_acl_categories"`
RedisACLChannels []string `json:"redis_acl_channels"`
RedisACLCommands []string `json:"redis_acl_commands"`
RedisACLKeys []string `json:"redis_acl_keys"`
}
// DatabaseUserACLReq represents input for updating a user's access control within a Redis Managed Database cluster
type DatabaseUserACLReq struct {
RedisACLCategories *[]string `json:"redis_acl_categories,omitempty"`
RedisACLChannels *[]string `json:"redis_acl_channels,omitempty"`
RedisACLCommands *[]string `json:"redis_acl_commands,omitempty"`
RedisACLKeys *[]string `json:"redis_acl_keys,omitempty"`
}
// databaseUserBase holds the API response for retrieving a single database user within a Managed Database
type databaseUserBase struct {
DatabaseUser *DatabaseUser `json:"user"`
}
// databaseUsersBase holds the API response for retrieving a list of database users within a Managed Database
type databaseUsersBase struct {
DatabaseUsers []DatabaseUser `json:"users"`
Meta *Meta `json:"meta"`
}
// DatabaseUserCreateReq struct used to create a user within a Managed Database.
type DatabaseUserCreateReq struct {
Username string `json:"username"`
Password string `json:"password,omitempty"`
Encryption string `json:"encryption,omitempty"`
}
// DatabaseUserUpdateReq struct used to update a user within a Managed Database.
type DatabaseUserUpdateReq struct {
Password string `json:"password"`
}
// DatabaseDB represents a logical database within a Managed Database cluster
type DatabaseDB struct {
Name string `json:"name"`
}
// databaseDBBase holds the API response for retrieving a single logical database within a Managed Database
type databaseDBBase struct {
DatabaseDB *DatabaseDB `json:"db"`
}
// databaseDBsBase holds the API response for retrieving a list of logical databases within a Managed Database
type databaseDBsBase struct {
DatabaseDBs []DatabaseDB `json:"dbs"`
Meta *Meta `json:"meta"`
}
// DatabaseDBCreateReq struct used to create a logical database within a Managed Database.
type DatabaseDBCreateReq struct {
Name string `json:"name"`
}
// databaseDBsBase holds the API response for retrieving a list of available maintenance updates within a Managed Database
type databaseUpdatesBase struct {
AvailableUpdates []string `json:"available_updates"`
}
// databaseMessage is a bsic object holding a return message for certain API endpoints
type databaseMessage struct {
Message string `json:"message"`
}
// DatabaseAlert represents a service alert for a Managed Database cluster
type DatabaseAlert struct {
Timestamp string `json:"timestamp"`
MessageType string `json:"message_type"`
Description string `json:"description"`
Recommendation string `json:"recommendation,omitempty"`
MaintenanceScheduled string `json:"maintenance_scheduled,omitempty"`
ResourceType string `json:"resource_type,omitempty"`
TableCount int `json:"table_count,omitempty"`
}
// databaseDBsBase holds the API response for querying service alerts within a Managed Database
type databaseAlertsBase struct {
DatabaseAlerts []DatabaseAlert `json:"alerts"`
}
// DatabaseListAlertsReq struct used to query service alerts for a Managed Database.
type DatabaseListAlertsReq struct {
Period string `json:"period"`
}
// DatabaseMigration represents migration details for a Managed Database cluster
type DatabaseMigration struct {
Status string `json:"status"`
Method string `json:"method,omitempty"`
Error string `json:"error,omitempty"`
Credentials DatabaseCredentials `json:"credentials"`
}
// DatabaseCredentials represents migration credentials for migration within a Managed Database cluster
type DatabaseCredentials struct {
Host string `json:"host"`
Port int `json:"port"`
Username string `json:"username"`
Password string `json:"password"`
Database string `json:"database,omitempty"`
IgnoredDatabases string `json:"ignored_databases,omitempty"`
SSL *bool `json:"ssl"`
}
// databaseMigrationBase represents a migration status object API response for a Managed Database
type databaseMigrationBase struct {
Migration *DatabaseMigration `json:"migration"`
}
// DatabaseMigrationStartReq struct used to start a migration for a Managed Database.
type DatabaseMigrationStartReq struct {
Host string `json:"host"`
Port int `json:"port"`
Username string `json:"username"`
Password string `json:"password"`
Database string `json:"database,omitempty"`
IgnoredDatabases string `json:"ignored_databases,omitempty"`
SSL *bool `json:"ssl"`
}
// DatabaseAddReplicaReq struct used to add a read-only replica to a Managed Database.
type DatabaseAddReplicaReq struct {
Region string `json:"region,omitempty"`
Label string `json:"label,omitempty"`
}
// DatabaseBackups represents backup information for a Managed Database cluster
type DatabaseBackups struct {
LatestBackup DatabaseBackup `json:"latest_backup,omitempty"`
OldestBackup DatabaseBackup `json:"oldest_backup,omitempty"`
}
// DatabaseBackup represents individual backup details for a Managed Database cluster
type DatabaseBackup struct {
Date string `json:"date"`
Time string `json:"time"`
}
// DatabaseBackupRestoreReq struct used to restore the backup of a Managed Database to a new subscription.
type DatabaseBackupRestoreReq struct {
Label string `json:"label,omitempty"`
Type string `json:"type,omitempty"`
Date string `json:"date,omitempty"`
Time string `json:"time,omitempty"`
}
// DatabaseForkReq struct used to fork a Managed Database to a new subscription from a backup.
type DatabaseForkReq struct {
Label string `json:"label,omitempty"`
Region string `json:"region,omitempty"`
Plan string `json:"plan,omitempty"`
Type string `json:"type,omitempty"`
Date string `json:"date,omitempty"`
Time string `json:"time,omitempty"`
}
// DatabaseConnectionPool represents a PostgreSQL connection pool within a Managed Database cluster
type DatabaseConnectionPool struct {
Name string `json:"name"`
Database string `json:"database"`
Username string `json:"username"`
Mode string `json:"mode"`
Size int `json:"size"`
}
// DatabaseConnections represents a an object containing used and available connections for a PostgreSQL Managed Database cluster
type DatabaseConnections struct {
Used int `json:"used"`
Available int `json:"available"`
Max int `json:"max"`
}
// databaseConnectionPoolBase represents the API response for retrieving a single connection pool for a PostgreSQL Managed Database
type databaseConnectionPoolBase struct {
ConnectionPool *DatabaseConnectionPool `json:"connection_pool"`
}
// databaseConnectionPoolBase represents the API response for retrieving all connection pool information for a PostgreSQL Managed Database
type databaseConnectionPoolsBase struct {
Connections *DatabaseConnections `json:"connections"`
ConnectionPools []DatabaseConnectionPool `json:"connection_pools"`
Meta *Meta `json:"meta"`
}
// DatabaseConnectionPoolCreateReq struct used to create a connection pool within a PostgreSQL Managed Database.
type DatabaseConnectionPoolCreateReq struct {
Name string `json:"name,omitempty"`
Database string `json:"database,omitempty"`
Username string `json:"username,omitempty"`
Mode string `json:"mode,omitempty"`
Size int `json:"size,omitempty"`
}
// DatabaseConnectionPoolUpdateReq struct used to update a connection pool within a PostgreSQL Managed Database.
type DatabaseConnectionPoolUpdateReq struct {
Database string `json:"database,omitempty"`
Username string `json:"username,omitempty"`
Mode string `json:"mode,omitempty"`
Size int `json:"size,omitempty"`
}
// DatabaseAdvancedOptions represents user configurable advanced options within a PostgreSQL Managed Database cluster
type DatabaseAdvancedOptions struct {
AutovacuumAnalyzeScaleFactor float32 `json:"autovacuum_analyze_scale_factor,omitempty"`
AutovacuumAnalyzeThreshold int `json:"autovacuum_analyze_threshold,omitempty"`
AutovacuumFreezeMaxAge int `json:"autovacuum_freeze_max_age,omitempty"`
AutovacuumMaxWorkers int `json:"autovacuum_max_workers,omitempty"`
AutovacuumNaptime int `json:"autovacuum_naptime,omitempty"`
AutovacuumVacuumCostDelay int `json:"autovacuum_vacuum_cost_delay,omitempty"`
AutovacuumVacuumCostLimit int `json:"autovacuum_vacuum_cost_limit,omitempty"`
AutovacuumVacuumScaleFactor float32 `json:"autovacuum_vacuum_scale_factor,omitempty"`
AutovacuumVacuumThreshold int `json:"autovacuum_vacuum_threshold,omitempty"`
BGWRITERDelay int `json:"bgwriter_delay,omitempty"`
BGWRITERFlushAFter int `json:"bgwriter_flush_after,omitempty"`
BGWRITERLRUMaxPages int `json:"bgwriter_lru_maxpages,omitempty"`
BGWRITERLRUMultiplier float32 `json:"bgwriter_lru_multiplier,omitempty"`
DeadlockTimeout int `json:"deadlock_timeout,omitempty"`
DefaultToastCompression string `json:"default_toast_compression,omitempty"`
IdleInTransactionSessionTimeout int `json:"idle_in_transaction_session_timeout,omitempty"`
Jit *bool `json:"jit,omitempty"`
LogAutovacuumMinDuration int `json:"log_autovacuum_min_duration,omitempty"`
LogErrorVerbosity string `json:"log_error_verbosity,omitempty"`
LogLinePrefix string `json:"log_line_prefix,omitempty"`
LogMinDurationStatement int `json:"log_min_duration_statement,omitempty"`
MaxFilesPerProcess int `json:"max_files_per_process,omitempty"`
MaxLocksPerTransaction int `json:"max_locks_per_transaction,omitempty"`
MaxLogicalReplicationWorkers int `json:"max_logical_replication_workers,omitempty"`
MaxParallelWorkers int `json:"max_parallel_workers,omitempty"`
MaxParallelWorkersPerGather int `json:"max_parallel_workers_per_gather,omitempty"`
MaxPredLocksPerTransaction int `json:"max_pred_locks_per_transaction,omitempty"`
MaxPreparedTransactions int `json:"max_prepared_transactions,omitempty"`
MaxReplicationSlots int `json:"max_replication_slots,omitempty"`
MaxStackDepth int `json:"max_stack_depth,omitempty"`
MaxStandbyArchiveDelay int `json:"max_standby_archive_delay,omitempty"`
MaxStandbyStreamingDelay int `json:"max_standby_streaming_delay,omitempty"`
MaxWalSenders int `json:"max_wal_senders,omitempty"`
MaxWorkerProcesses int `json:"max_worker_processes,omitempty"`
PGPartmanBGWInterval int `json:"pg_partman_bgw.interval,omitempty"`
PGPartmanBGWRole string `json:"pg_partman_bgw.role,omitempty"`
PGStateStatementsTrack string `json:"pg_stat_statements.track,omitempty"`
TempFileLimit int `json:"temp_file_limit,omitempty"`
TrackActivityQuerySize int `json:"track_activity_query_size,omitempty"`
TrackCommitTimestamp string `json:"track_commit_timestamp,omitempty"`
TrackFunctions string `json:"track_functions,omitempty"`
TrackIOTiming string `json:"track_io_timing,omitempty"`
WALSenderTImeout int `json:"wal_sender_timeout,omitempty"`
WALWriterDelay int `json:"wal_writer_delay,omitempty"`
}
// AvailableOption represents an available advanced configuration option for a PostgreSQL Managed Database cluster
type AvailableOption struct {
Name string `json:"name"`
Type string `json:"type"`
Enumerals []string `json:"enumerals,omitempty"`
MinValue *int `json:"min_value,omitempty"`
MaxValue *int `json:"max_value,omitempty"`
AltValues []int `json:"alt_values,omitempty"`
Units string `json:"units,omitempty"`
}
// databaseAdvancedOptionsBase represents the API response for PostgreSQL advanced configuration options for a Managed Database
type databaseAdvancedOptionsBase struct {
ConfiguredOptions *DatabaseAdvancedOptions `json:"configured_options"`
AvailableOptions []AvailableOption `json:"available_options"`
}
// DatabaseAvailableVersions represents available versions upgrades for a Managed Database cluster
type DatabaseAvailableVersions struct {
AvailableVersions []string `json:"available_versions"`
}
// DatabaseVersionUpgradeReq struct used to initiate a version upgrade for a PostgreSQL Managed Database.
type DatabaseVersionUpgradeReq struct {
Version string `json:"version,omitempty"`
}
// ListPlans retrieves all database plans
func (d *DatabaseServiceHandler) ListPlans(ctx context.Context, options *DBPlanListOptions) ([]DatabasePlan, *Meta, *http.Response, error) {
uri := fmt.Sprintf("%s/plans", databasePath)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, nil, err
}
newValues, err := query.Values(options)
if err != nil {
return nil, nil, nil, err
}
req.URL.RawQuery = newValues.Encode()
databasePlans := new(databasePlansBase)
resp, err := d.client.DoWithContext(ctx, req, databasePlans)
if err != nil {
return nil, nil, nil, err
}
return databasePlans.DatabasePlans, databasePlans.Meta, resp, nil
}
// List retrieves all databases on your account
func (d *DatabaseServiceHandler) List(ctx context.Context, options *DBListOptions) ([]Database, *Meta, *http.Response, error) { //nolint:dupl,lll
req, err := d.client.NewRequest(ctx, http.MethodGet, databasePath, nil)
if err != nil {
return nil, nil, nil, err
}
newValues, err := query.Values(options)
if err != nil {
return nil, nil, nil, err
}
req.URL.RawQuery = newValues.Encode()
databases := new(databasesBase)
resp, err := d.client.DoWithContext(ctx, req, databases)
if err != nil {
return nil, nil, nil, err
}
return databases.Databases, databases.Meta, resp, nil
}
// Create will create the Managed Database with the given parameters
func (d *DatabaseServiceHandler) Create(ctx context.Context, databaseReq *DatabaseCreateReq) (*Database, *http.Response, error) {
req, err := d.client.NewRequest(ctx, http.MethodPost, databasePath, databaseReq)
if err != nil {
return nil, nil, err
}
database := new(databaseBase)
resp, err := d.client.DoWithContext(ctx, req, database)
if err != nil {
return nil, nil, err
}
return database.Database, resp, nil
}
// Get will get the Managed Database with the given databaseID
func (d *DatabaseServiceHandler) Get(ctx context.Context, databaseID string) (*Database, *http.Response, error) {
uri := fmt.Sprintf("%s/%s", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
database := new(databaseBase)
resp, err := d.client.DoWithContext(ctx, req, database)
if err != nil {
return nil, nil, err
}
return database.Database, resp, nil
}
// Update will update the Managed Database with the given parameters
func (d *DatabaseServiceHandler) Update(ctx context.Context, databaseID string, databaseReq *DatabaseUpdateReq) (*Database, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPut, uri, databaseReq)
if err != nil {
return nil, nil, err
}
database := new(databaseBase)
resp, err := d.client.DoWithContext(ctx, req, database)
if err != nil {
return nil, nil, err
}
return database.Database, resp, nil
}
// Delete a Managed database. All data will be permanently lost.
func (d *DatabaseServiceHandler) Delete(ctx context.Context, databaseID string) error {
uri := fmt.Sprintf("%s/%s", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodDelete, uri, nil)
if err != nil {
return err
}
_, err = d.client.DoWithContext(ctx, req, nil)
return err
}
// GetUsage retrieves disk, memory, and CPU usage information for your Managed Database.
func (d *DatabaseServiceHandler) GetUsage(ctx context.Context, databaseID string) (*DatabaseUsage, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/usage", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
databaseUsage := new(databaseUsageBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUsage)
if err != nil {
return nil, nil, err
}
return databaseUsage.Usage, resp, nil
}
// ListUsers retrieves all database users on your Managed Database.
func (d *DatabaseServiceHandler) ListUsers(ctx context.Context, databaseID string) ([]DatabaseUser, *Meta, *http.Response, error) { //nolint:dupl,lll
uri := fmt.Sprintf("%s/%s/users", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, nil, err
}
databaseUsers := new(databaseUsersBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUsers)
if err != nil {
return nil, nil, nil, err
}
return databaseUsers.DatabaseUsers, databaseUsers.Meta, resp, nil
}
// CreateUser will create a user within the Managed Database with the given parameters
func (d *DatabaseServiceHandler) CreateUser(ctx context.Context, databaseID string, databaseUserReq *DatabaseUserCreateReq) (*DatabaseUser, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s/users", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, databaseUserReq)
if err != nil {
return nil, nil, err
}
databaseUser := new(databaseUserBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUser)
if err != nil {
return nil, nil, err
}
return databaseUser.DatabaseUser, resp, nil
}
// GetUser retrieves information on an individual user within a Managed Database based on a username and databaseID
func (d *DatabaseServiceHandler) GetUser(ctx context.Context, databaseID, username string) (*DatabaseUser, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/users/%s", databasePath, databaseID, username)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
databaseUser := new(databaseUserBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUser)
if err != nil {
return nil, nil, err
}
return databaseUser.DatabaseUser, resp, nil
}
// UpdateUser will update a user within the Managed Database with the given parameters
func (d *DatabaseServiceHandler) UpdateUser(ctx context.Context, databaseID, username string, databaseUserReq *DatabaseUserUpdateReq) (*DatabaseUser, *http.Response, error) { //nolint:lll,dupl
uri := fmt.Sprintf("%s/%s/users/%s", databasePath, databaseID, username)
req, err := d.client.NewRequest(ctx, http.MethodPut, uri, databaseUserReq)
if err != nil {
return nil, nil, err
}
databaseUser := new(databaseUserBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUser)
if err != nil {
return nil, nil, err
}
return databaseUser.DatabaseUser, resp, nil
}
// DeleteUser will delete a user within the Managed database. All data will be permanently lost.
func (d *DatabaseServiceHandler) DeleteUser(ctx context.Context, databaseID, username string) error {
uri := fmt.Sprintf("%s/%s/users/%s", databasePath, databaseID, username)
req, err := d.client.NewRequest(ctx, http.MethodDelete, uri, nil)
if err != nil {
return err
}
_, err = d.client.DoWithContext(ctx, req, nil)
return err
}
// UpdateUserACL will update a user's access control within the Redis Managed Database
func (d *DatabaseServiceHandler) UpdateUserACL(ctx context.Context, databaseID, username string, databaseUserACLReq *DatabaseUserACLReq) (*DatabaseUser, *http.Response, error) { //nolint:lll,dupl
uri := fmt.Sprintf("%s/%s/users/%s/access-control", databasePath, databaseID, username)
req, err := d.client.NewRequest(ctx, http.MethodPut, uri, databaseUserACLReq)
if err != nil {
return nil, nil, err
}
databaseUser := new(databaseUserBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUser)
if err != nil {
return nil, nil, err
}
return databaseUser.DatabaseUser, resp, nil
}
// ListDBs retrieves all logical databases on your Managed Database.
func (d *DatabaseServiceHandler) ListDBs(ctx context.Context, databaseID string) ([]DatabaseDB, *Meta, *http.Response, error) { //nolint:dupl,lll
uri := fmt.Sprintf("%s/%s/dbs", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, nil, err
}
databaseDBs := new(databaseDBsBase)
resp, err := d.client.DoWithContext(ctx, req, databaseDBs)
if err != nil {
return nil, nil, nil, err
}
return databaseDBs.DatabaseDBs, databaseDBs.Meta, resp, nil
}
// CreateDB will create a logical database within the Managed Database with the given parameters
func (d *DatabaseServiceHandler) CreateDB(ctx context.Context, databaseID string, databaseDBReq *DatabaseDBCreateReq) (*DatabaseDB, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s/dbs", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, databaseDBReq)
if err != nil {
return nil, nil, err
}
databaseDB := new(databaseDBBase)
resp, err := d.client.DoWithContext(ctx, req, databaseDB)
if err != nil {
return nil, nil, err
}
return databaseDB.DatabaseDB, resp, nil
}
// GetDB retrieves information on an individual logical database within a Managed Database based on a dbname and databaseID
func (d *DatabaseServiceHandler) GetDB(ctx context.Context, databaseID, dbname string) (*DatabaseDB, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/dbs/%s", databasePath, databaseID, dbname)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
databaseDB := new(databaseDBBase)
resp, err := d.client.DoWithContext(ctx, req, databaseDB)
if err != nil {
return nil, nil, err
}
return databaseDB.DatabaseDB, resp, nil
}
// DeleteDB will delete a user within the Managed database
func (d *DatabaseServiceHandler) DeleteDB(ctx context.Context, databaseID, dbname string) error {
uri := fmt.Sprintf("%s/%s/dbs/%s", databasePath, databaseID, dbname)
req, err := d.client.NewRequest(ctx, http.MethodDelete, uri, nil)
if err != nil {
return err
}
_, err = d.client.DoWithContext(ctx, req, nil)
return err
}
// ListMaintenanceUpdates retrieves all available maintenance updates for your Managed Database.
func (d *DatabaseServiceHandler) ListMaintenanceUpdates(ctx context.Context, databaseID string) ([]string, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/maintenance", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
databaseUpdates := new(databaseUpdatesBase)
resp, err := d.client.DoWithContext(ctx, req, databaseUpdates)
if err != nil {
return nil, nil, err
}
return databaseUpdates.AvailableUpdates, resp, nil
}
// StartMaintenance will start the maintenance update process for your Managed Database
func (d *DatabaseServiceHandler) StartMaintenance(ctx context.Context, databaseID string) (string, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/maintenance", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, nil)
if err != nil {
return "", nil, err
}
databaseUpdates := new(databaseMessage)
resp, err := d.client.DoWithContext(ctx, req, databaseUpdates)
if err != nil {
return "", nil, err
}
return databaseUpdates.Message, resp, nil
}
// ListServiceAlerts queries for service alerts for the Managed Database using the given parameters
func (d *DatabaseServiceHandler) ListServiceAlerts(ctx context.Context, databaseID string, databaseAlertsReq *DatabaseListAlertsReq) ([]DatabaseAlert, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s/alerts", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, databaseAlertsReq)
if err != nil {
return nil, nil, err
}
databaseAlerts := new(databaseAlertsBase)
resp, err := d.client.DoWithContext(ctx, req, databaseAlerts)
if err != nil {
return nil, nil, err
}
return databaseAlerts.DatabaseAlerts, resp, nil
}
// GetMigrationStatus retrieves the migration status for your Managed Database.
func (d *DatabaseServiceHandler) GetMigrationStatus(ctx context.Context, databaseID string) (*DatabaseMigration, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/migration", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
databaseMigration := new(databaseMigrationBase)
resp, err := d.client.DoWithContext(ctx, req, databaseMigration)
if err != nil {
return nil, nil, err
}
return databaseMigration.Migration, resp, nil
}
// StartMigration will start a migration for the Managed Database using the given credentials.
func (d *DatabaseServiceHandler) StartMigration(ctx context.Context, databaseID string, databaseMigrationReq *DatabaseMigrationStartReq) (*DatabaseMigration, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s/migration", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, databaseMigrationReq)
if err != nil {
return nil, nil, err
}
databaseMigration := new(databaseMigrationBase)
resp, err := d.client.DoWithContext(ctx, req, databaseMigration)
if err != nil {
return nil, nil, err
}
return databaseMigration.Migration, resp, nil
}
// DetachMigration will detach a migration from the Managed database.
func (d *DatabaseServiceHandler) DetachMigration(ctx context.Context, databaseID string) error {
uri := fmt.Sprintf("%s/%s/migration", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodDelete, uri, nil)
if err != nil {
return err
}
_, err = d.client.DoWithContext(ctx, req, nil)
return err
}
// AddReadOnlyReplica will add a read-only replica node to the Managed Database with the given parameters
func (d *DatabaseServiceHandler) AddReadOnlyReplica(ctx context.Context, databaseID string, databaseReplicaReq *DatabaseAddReplicaReq) (*Database, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s/read-replica", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, databaseReplicaReq)
if err != nil {
return nil, nil, err
}
database := new(databaseBase)
resp, err := d.client.DoWithContext(ctx, req, database)
if err != nil {
return nil, nil, err
}
return database.Database, resp, nil
}
// PromoteReadReplica will promote a read-only replica to its own standalone Managed Database subscription.
func (d *DatabaseServiceHandler) PromoteReadReplica(ctx context.Context, databaseID string) error {
uri := fmt.Sprintf("%s/%s/promote-read-replica", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, nil)
if err != nil {
return err
}
_, err = d.client.DoWithContext(ctx, req, nil)
return err
}
// GetBackupInformation retrieves backup information for your Managed Database.
func (d *DatabaseServiceHandler) GetBackupInformation(ctx context.Context, databaseID string) (*DatabaseBackups, *http.Response, error) {
uri := fmt.Sprintf("%s/%s/backups", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, nil, err
}
databaseBackups := new(DatabaseBackups)
resp, err := d.client.DoWithContext(ctx, req, databaseBackups)
if err != nil {
return nil, nil, err
}
return databaseBackups, resp, nil
}
// RestoreFromBackup will create a new subscription of the same plan from a backup of the Managed Database using the given parameters
func (d *DatabaseServiceHandler) RestoreFromBackup(ctx context.Context, databaseID string, databaseRestoreReq *DatabaseBackupRestoreReq) (*Database, *http.Response, error) { //nolint:lll
uri := fmt.Sprintf("%s/%s/restore", databasePath, databaseID)
req, err := d.client.NewRequest(ctx, http.MethodPost, uri, databaseRestoreReq)
if err != nil {
return nil, nil, err