📚 Documentation: databases has no member 'upsertDocument'

[Jaycyn]

💭 Description

Documentation should not... show a function that does not exist. Quite possibly replaced with .updateDocument but documentation needs clarity as that function updates an existing document, but does not appear to create a new one if needed.

Upsert is a pretty important function for updating existing documents. Documentation shows it is available, code shows it's not.

https://appwrite.io/docs/references/cloud/client-apple/databases#upsertDocument

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

[ChiragAgg5k]

@Jaycyn Hi there, upsert document seems to be valid method that can be found here -

sdk-for-apple/Sources/Appwrite/Services/Databases.swift

Line 235 in 04fc109

open func upsertDocument<T>(

Since it was pretty recently added, can you verify if you are on the latest version of the sdk?

[Jaycyn]

@ChiragAgg5k Thank you for taking a look

I can confirm we had SDK 9.0.1 installed, to which the function was not found. As a test, I just now created a brand new macOS project, adding 9.0.1 version of the sdk-for-apple. See below.

The upsert function is not found in that SDK.

However, after creating a new project and adding the 10.1.0 of the sdk-for-apple, the .upsertDocument is found. So, I think we are all set.

[Jaycyn]

@ChiragAgg5k

Perhaps I spoke too soon. While this was a documentation issue, we are also not able to get the function working.

When this code is run

do {
    let doc = try await databases.upsertDocument(
        databaseId: databaseId,
        collectionId: collectionId,
        documentId: documentId,
        data: ["title": "New Title", "author": "New Author"]
    )
    print("  upserted book")
    print(doc)
} catch {
    print(error)
    print(error.localizedDescription)
}

The catch blocks outputs

"Server Error"

with no other information. We can create, Read and Delete that document. It does have two properties title and author and we receive the same error attempting to upsertDocument either or both.

Should this be filed as a bug report, incorrect documentation or are we just doing something wrong?

[ChiragAgg5k]

@Jaycyn Hi there, glad to know updating the SDK worked for actually finding the method!
Now for the 500 errors, out team member recently discovered the same issue and it was because of this:

Ok, so the problem here is that the objects in the array have different attributes they are sending. For example, my datasource has attributes that exist on some books but not all. So i think if my source is null i still have to pass it in null

Solution they found was:

Forced all attributes to be None if they don't exist in the source so everything is consistent. With that, payload matches across the board. Able to blast 1k records now.

This definitely should not be a 500 error and we will work on returning a better error for this scenario.

Can you confirm if this is the same scenarior that's happening in your case?

cc @EVDOG4LIFE

[Jaycyn]

@ChiragAgg5k

Thank you for the followup. I don't think it appears to be the same scenario. The code in my above post attempts to upsert the book with document id of "1", two properties, title and author like this

data: ["title": "New Title", "author": "New Author"]

and per the Appwrite console those keys exactly match the schema; here's a screenshot of my console for the Books collection

I am also a little unclear on this point

datasource has attributes that exist on some books but not all

The attributes in console exist for all objects within a collection as, from what I understand, a collection is homogeneous - e.g. the keys for all documents are all the same and must exist while the value can be nil/optional

If the datasource that's being referred to is a model, the keys would still always exist, with values that may be optional. Maybe they mean that have two different Book Models?

cc @EVDOG4LIFE