Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.

Add document:createOrReplace#61

Merged
y-abs merged 13 commits into
3-devfrom
KZL-1350-document-createOrReplace
Mar 6, 2020
Merged

Add document:createOrReplace#61
y-abs merged 13 commits into
3-devfrom
KZL-1350-document-createOrReplace

Conversation

@y-abs
Copy link
Copy Markdown
Contributor

@y-abs y-abs commented Feb 21, 2020

What does this PR do ?

This PR implements the document:createOrReplace method with its unit tests.

How should this be manually tested?

Clone this branch and run unit tests
./gradlew test

When it succeed, compile it

./gradlew jar

Initiate another java project by adding the compiled SDK as a dependency.

Then, run Kuzzle, create an index nyc-open-data and a yellow-taxi collection in the admin console.
Finally, run this code

import io.kuzzle.sdk.*;
import io.kuzzle.sdk.Options.KuzzleOptions;
import io.kuzzle.sdk.Options.Protocol.WebSocketOptions;
import io.kuzzle.sdk.Protocol.WebSocket;

import java.util.concurrent.ConcurrentHashMap;

public class createOrReplaceDocument {
    private static Kuzzle kuzzle;

    public static void main(String[] args) {
        WebSocketOptions opts = new WebSocketOptions();
        opts.setAutoReconnect(true).setConnectionTimeout(42000);

        try {
            WebSocket ws = new WebSocket("localhost", opts);

            kuzzle = new Kuzzle(ws, (KuzzleOptions) null);

            kuzzle.connect();

            ConcurrentHashMap<String, Object> content = new ConcurrentHashMap<>();
            content.put("name", "Yoann");

            kuzzle.getDocumentController().createOrReplace("nyc-open-data", "yellow-taxi", "some-id", content)
            .get();
            System.out.println("New document added to the yellow-taxi collection!");
        }  catch (Exception e) {
            e.printStackTrace();
        }

        kuzzle.disconnect();
    }
};

You should see the document in your collection.

@y-abs y-abs self-assigned this Feb 21, 2020
Copy link
Copy Markdown
Contributor

@scottinet scottinet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also report changes requested in #55 and #59

Comment thread doc/3/controllers/document/create-or-replace/index.md
Comment thread src/main/java/io/kuzzle/sdk/API/Controllers/DocumentController.java Outdated
@y-abs y-abs requested a review from scottinet February 26, 2020 16:28
Comment thread doc/3/controllers/document/create-or-replace/index.md Outdated

ConcurrentHashMap<String, Object> response = kuzzle.getDocumentController().createOrReplace("nyc-open-data", "yellow-taxi", "some-id", document)
.get();
System.out.println(response); No newline at end of file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you do the snippet test on something from the result as well as for the other methods?

Also can you add the result of the println in comment?
It helps developer to better apprehend the structure of the response object they have. We try to do this for every method (Look the Javascript SDK and Doc)

y-abs and others added 2 commits February 27, 2020 10:14
@y-abs y-abs requested a review from Aschen February 28, 2020 14:13
Comment thread doc/3/controllers/document/create-or-replace/snippets/create-or-replace.java Outdated
@y-abs y-abs merged commit 0900cb7 into 3-dev Mar 6, 2020
@y-abs y-abs deleted the KZL-1350-document-createOrReplace branch March 6, 2020 10:43
@jenow jenow mentioned this pull request May 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants