Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
persist-credentials: true
ref: ${{ github.event.pull_request.head.ref }}

- name: Install dependencies
run: dart pub get

- name: Format Dart code
run: dart format .

Expand All @@ -29,5 +32,5 @@ jobs:
- name: Add & Commit
uses: EndBug/[email protected]
with:
add: lib
add: '["lib", "test"]'

5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## 19.3.0

* Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance
* Add `Operator` class for atomic modification of rows via update, bulk update, upsert, and bulk upsert operations

## 19.2.1

* Add transaction support for Databases and TablesDB
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:

```yml
dependencies:
dart_appwrite: ^19.2.1
dart_appwrite: ^19.3.0
```
You can install packages from the command line:
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/list-identities.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Account account = Account(client);

IdentityList result = await account.listIdentities(
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/account/list-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Account account = Account(client);

LogList result = await account.listLogs(
queries: [], // (optional)
total: false, // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/databases/create-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -11,7 +13,7 @@ Collection result = await databases.createCollection(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
name: '<NAME>',
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
documentSecurity: false, // (optional)
enabled: false, // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/databases/create-document.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -18,6 +20,6 @@ Document result = await databases.createDocument(
"age": 30,
"isAdmin": false
},
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
transactionId: '<TRANSACTION_ID>', // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/databases/list-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ AttributeList result = await databases.listAttributes(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/databases/list-collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ CollectionList result = await databases.listCollections(
databaseId: '<DATABASE_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/databases/list-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ DocumentList result = await databases.listDocuments(
collectionId: '<COLLECTION_ID>',
queries: [], // (optional)
transactionId: '<TRANSACTION_ID>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/databases/list-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ IndexList result = await databases.listIndexes(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/databases/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Databases databases = Databases(client);
DatabaseList result = await databases.list(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/databases/update-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -11,7 +13,7 @@ Collection result = await databases.updateCollection(
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
name: '<NAME>',
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
documentSecurity: false, // (optional)
enabled: false, // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/databases/update-document.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -12,6 +14,6 @@ Document result = await databases.updateDocument(
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {}, // (optional)
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
transactionId: '<TRANSACTION_ID>', // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/databases/upsert-document.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -12,6 +14,6 @@ Document result = await databases.upsertDocument(
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {},
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
transactionId: '<TRANSACTION_ID>', // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/functions/list-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ DeploymentList result = await functions.listDeployments(
functionId: '<FUNCTION_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/functions/list-executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Functions functions = Functions(client);
ExecutionList result = await functions.listExecutions(
functionId: '<FUNCTION_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/functions/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Functions functions = Functions(client);
FunctionList result = await functions.list(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
19 changes: 19 additions & 0 deletions docs/examples/messaging/create-resend-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import 'package:dart_appwrite/dart_appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key

Messaging messaging = Messaging(client);

Provider result = await messaging.createResendProvider(
providerId: '<PROVIDER_ID>',
name: '<NAME>',
apiKey: '<API_KEY>', // (optional)
fromName: '<FROM_NAME>', // (optional)
fromEmail: '[email protected]', // (optional)
replyToName: '<REPLY_TO_NAME>', // (optional)
replyToEmail: '[email protected]', // (optional)
enabled: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-message-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
LogList result = await messaging.listMessageLogs(
messageId: '<MESSAGE_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
MessageList result = await messaging.listMessages(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-provider-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
LogList result = await messaging.listProviderLogs(
providerId: '<PROVIDER_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
ProviderList result = await messaging.listProviders(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-subscriber-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
LogList result = await messaging.listSubscriberLogs(
subscriberId: '<SUBSCRIBER_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-subscribers.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ SubscriberList result = await messaging.listSubscribers(
topicId: '<TOPIC_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
TargetList result = await messaging.listTargets(
messageId: '<MESSAGE_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-topic-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
LogList result = await messaging.listTopicLogs(
topicId: '<TOPIC_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/messaging/list-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Messaging messaging = Messaging(client);
TopicList result = await messaging.listTopics(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
19 changes: 19 additions & 0 deletions docs/examples/messaging/update-resend-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import 'package:dart_appwrite/dart_appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key

Messaging messaging = Messaging(client);

Provider result = await messaging.updateResendProvider(
providerId: '<PROVIDER_ID>',
name: '<NAME>', // (optional)
enabled: false, // (optional)
apiKey: '<API_KEY>', // (optional)
fromName: '<FROM_NAME>', // (optional)
fromEmail: '[email protected]', // (optional)
replyToName: '<REPLY_TO_NAME>', // (optional)
replyToEmail: '<REPLY_TO_EMAIL>', // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/sites/list-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ DeploymentList result = await sites.listDeployments(
siteId: '<SITE_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/sites/list-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Sites sites = Sites(client);
ExecutionList result = await sites.listLogs(
siteId: '<SITE_ID>',
queries: [], // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/sites/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Sites sites = Sites(client);
SiteList result = await sites.list(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/storage/create-bucket.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -10,7 +12,7 @@ Storage storage = Storage(client);
Bucket result = await storage.createBucket(
bucketId: '<BUCKET_ID>',
name: '<NAME>',
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
fileSecurity: false, // (optional)
enabled: false, // (optional)
maximumFileSize: 1, // (optional)
Expand Down
4 changes: 3 additions & 1 deletion docs/examples/storage/create-file.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import 'dart:io';
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -12,5 +14,5 @@ File result = await storage.createFile(
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
file: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'),
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/storage/list-buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Storage storage = Storage(client);
BucketList result = await storage.listBuckets(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/storage/list-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ FileList result = await storage.listFiles(
bucketId: '<BUCKET_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
total: false, // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/storage/update-bucket.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -10,7 +12,7 @@ Storage storage = Storage(client);
Bucket result = await storage.updateBucket(
bucketId: '<BUCKET_ID>',
name: '<NAME>',
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
fileSecurity: false, // (optional)
enabled: false, // (optional)
maximumFileSize: 1, // (optional)
Expand Down
4 changes: 3 additions & 1 deletion docs/examples/storage/update-file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -11,5 +13,5 @@ File result = await storage.updateFile(
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
name: '<NAME>', // (optional)
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/tablesdb/create-row.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -18,6 +20,6 @@ Row result = await tablesDB.createRow(
"age": 30,
"isAdmin": false
},
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
transactionId: '<TRANSACTION_ID>', // (optional)
);
4 changes: 3 additions & 1 deletion docs/examples/tablesdb/create-table.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:dart_appwrite/dart_appwrite.dart';
import 'package:dart_appwrite/permission.dart';
import 'package:dart_appwrite/role.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -11,7 +13,7 @@ Table result = await tablesDB.createTable(
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
name: '<NAME>',
permissions: ["read("any")"], // (optional)
permissions: [Permission.read(Role.any())], // (optional)
rowSecurity: false, // (optional)
enabled: false, // (optional)
);
1 change: 1 addition & 0 deletions docs/examples/tablesdb/list-columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ ColumnList result = await tablesDB.listColumns(
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
queries: [], // (optional)
total: false, // (optional)
);
Loading