Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Change Log

## 30.0.0-rc.1

* Breaking: `EmbeddingModel` no longer offers `embedding-gemma` or `bge-small`
* Added: `documentsDB`, `vectorsDB`, `mysql`, `postgresql`, and `mongo` services, no longer hidden from server SDKs
* Added: `DocumentsDBIndexType` and `VectorsDBIndexType` enums
* Added: dedicated database models for branches, backups, restorations, poolers, PITR windows, extensions, and executions
* Added: `PostgresExtension`, `VectorsdbCollection`, `AttributeObject`, and `AttributeVector` models
* Added: `userId`, `emailHash`, and `name` parameters to `avatars.getPhoto`
* Added: `error`, `containerStatus`, and `lifecycleState` on the `Database` model
* Added: `changelogWatermark` on the `DatabaseMigration` model
* Added: `total` on the `DedicatedDatabaseBranchList` model
* Updated: `DedicatedDatabaseOperation.status` documents the new `queued` state

## 29.0.0

* Breaking: requires PHP 8.5 or later, up from PHP 8.2
Expand Down
579 changes: 579 additions & 0 deletions docs/documentsdb.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/examples/avatars/get-initials.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ $result = $avatars->getInitials(
name: '<NAME>', // optional
width: 0, // optional
height: 0, // optional
background: '' // optional
background: 'FFFFFF' // optional
);
```
2 changes: 1 addition & 1 deletion docs/examples/avatars/get-photo.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $result = $avatars->getPhoto(
quality: 0, // optional
output: 'png', // optional
rating: 'g', // optional
userId: '', // optional
userId: 'current()', // optional
emailHash: '<EMAIL_HASH>', // optional
name: '<NAME>' // optional
);
Expand Down
8 changes: 4 additions & 4 deletions docs/examples/databases/create-big-int-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ $databases = new Databases($client);
$result = $databases->createBigIntAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
min: null, // optional
max: null, // optional
default: null, // optional
min: 0, // optional
max: 1000000, // optional
default: 0, // optional
array: false // optional
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/create-boolean-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createBooleanAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: false, // optional
array: false // optional
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/databases/create-datetime-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createDatetimeAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: '2020-10-15T06:38:00.000+00:00', // optional
array: false // optional
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/databases/create-email-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createEmailAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: 'email@example.com', // optional
array: false // optional
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/databases/create-enum-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ $databases = new Databases($client);
$result = $databases->createEnumAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
elements: [],
key: '<KEY>',
elements: ["active", "inactive"],
required: false,
default: '<DEFAULT>', // optional
default: 'active', // optional
array: false // optional
);
```
8 changes: 4 additions & 4 deletions docs/examples/databases/create-float-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ $databases = new Databases($client);
$result = $databases->createFloatAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
min: null, // optional
max: null, // optional
default: null, // optional
min: 0, // optional
max: 100, // optional
default: 10.5, // optional
array: false // optional
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/create-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ $databases = new Databases($client);
$result = $databases->createIndex(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
type: DatabasesIndexType::KEY(),
attributes: [],
orders: [OrderBy::ASC()], // optional
Expand Down
8 changes: 4 additions & 4 deletions docs/examples/databases/create-integer-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ $databases = new Databases($client);
$result = $databases->createIntegerAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
min: null, // optional
max: null, // optional
default: null, // optional
min: 0, // optional
max: 100, // optional
default: 10, // optional
array: false // optional
);
```
4 changes: 2 additions & 2 deletions docs/examples/databases/create-ip-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->createIpAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: '', // optional
default: '192.0.2.0', // optional
array: false // optional
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/create-line-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createLineAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: [[1, 2], [3, 4], [5, 6]] // optional
);
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/databases/create-longtext-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->createLongtextAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: '<DEFAULT>', // optional
default: 'Hello World', // optional
array: false, // optional
encrypt: false // optional
);
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/databases/create-mediumtext-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->createMediumtextAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: '<DEFAULT>', // optional
default: 'Hello World', // optional
array: false, // optional
encrypt: false // optional
);
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/databases/create-point-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createPointAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: [1, 2] // optional
);
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/databases/create-polygon-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createPolygonAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: [[[1, 2], [3, 4], [5, 6], [1, 2]]] // optional
);
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/databases/create-relationship-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ $result = $databases->createRelationshipAttribute(
relatedCollectionId: '<RELATED_COLLECTION_ID>',
type: RelationshipType::ONETOONE(),
twoWay: false, // optional
key: '', // optional
twoWayKey: '', // optional
key: '<KEY>', // optional
twoWayKey: '<TWO_WAY_KEY>', // optional
onDelete: RelationMutate::CASCADE() // optional
);
```
4 changes: 2 additions & 2 deletions docs/examples/databases/create-string-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ $databases = new Databases($client);
$result = $databases->createStringAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
size: 1,
required: false,
default: '<DEFAULT>', // optional
default: 'Hello World', // optional
array: false, // optional
encrypt: false // optional
);
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/databases/create-text-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->createTextAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: '<DEFAULT>', // optional
default: 'Hello World', // optional
array: false, // optional
encrypt: false // optional
);
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/databases/create-url-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $databases = new Databases($client);
$result = $databases->createUrlAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: 'https://example.com', // optional
array: false // optional
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/databases/create-varchar-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ $databases = new Databases($client);
$result = $databases->createVarcharAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
size: 1,
required: false,
default: '<DEFAULT>', // optional
default: 'Hello World', // optional
array: false, // optional
encrypt: false // optional
);
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/databases/decrement-document-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ $result = $databases->decrementDocumentAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
attribute: '',
value: null, // optional
min: null, // optional
attribute: '<ATTRIBUTE>',
value: 1, // optional
min: 0, // optional
transactionId: '<TRANSACTION_ID>' // optional
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/delete-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ $databases = new Databases($client);
$result = $databases->deleteAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: ''
key: '<KEY>'
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/delete-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ $databases = new Databases($client);
$result = $databases->deleteIndex(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: ''
key: '<KEY>'
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/get-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ $databases = new Databases($client);
$result = $databases->getAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: ''
key: '<KEY>'
);
```
2 changes: 1 addition & 1 deletion docs/examples/databases/get-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ $databases = new Databases($client);
$result = $databases->getIndex(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: ''
key: '<KEY>'
);
```
6 changes: 3 additions & 3 deletions docs/examples/databases/increment-document-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ $result = $databases->incrementDocumentAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
attribute: '',
value: null, // optional
max: null, // optional
attribute: '<ATTRIBUTE>',
value: 1, // optional
max: 100, // optional
transactionId: '<TRANSACTION_ID>' // optional
);
```
10 changes: 5 additions & 5 deletions docs/examples/databases/update-big-int-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ $databases = new Databases($client);
$result = $databases->updateBigIntAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: null,
min: null, // optional
max: null, // optional
newKey: '' // optional
default: 0,
min: 0, // optional
max: 1000000, // optional
newKey: '<NEW_KEY>' // optional
);
```
4 changes: 2 additions & 2 deletions docs/examples/databases/update-boolean-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->updateBooleanAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: false,
newKey: '' // optional
newKey: '<NEW_KEY>' // optional
);
```
4 changes: 2 additions & 2 deletions docs/examples/databases/update-datetime-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->updateDatetimeAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: '2020-10-15T06:38:00.000+00:00',
newKey: '' // optional
newKey: '<NEW_KEY>' // optional
);
```
4 changes: 2 additions & 2 deletions docs/examples/databases/update-email-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ $databases = new Databases($client);
$result = $databases->updateEmailAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: 'email@example.com',
newKey: '' // optional
newKey: '<NEW_KEY>' // optional
);
```
8 changes: 4 additions & 4 deletions docs/examples/databases/update-enum-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ $databases = new Databases($client);
$result = $databases->updateEnumAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
elements: [],
key: '<KEY>',
elements: ["active", "inactive"],
required: false,
default: '<DEFAULT>',
newKey: '' // optional
default: 'active',
newKey: '<NEW_KEY>' // optional
);
```
10 changes: 5 additions & 5 deletions docs/examples/databases/update-float-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ $databases = new Databases($client);
$result = $databases->updateFloatAttribute(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
key: '',
key: '<KEY>',
required: false,
default: null,
min: null, // optional
max: null, // optional
newKey: '' // optional
default: 10.5,
min: 0, // optional
max: 100, // optional
newKey: '<NEW_KEY>' // optional
);
```
Loading