(dsl): Support create and upsert requests #6

dbulaja98 · 2022-11-23T15:37:54Z

No description provided.

modules/library/src/main/scala/zio/elasticsearch/ElasticRequest.scala

drmarjanovic · 2022-11-23T15:43:15Z

modules/library/src/main/scala/zio/elasticsearch/ElasticRequest.scala

  private[elasticsearch] final case class GetById(
    index: IndexName,
    id: DocumentId,
    routing: Option[Routing] = None
  ) extends ElasticRequest[Option[Document]]

+  private[elasticsearch] final case class PutItem(


Let's use PutDocument. Or maybe even Put. Also, in the future maybe we will have some other Put* and GetById*, so not sure if should we use GetDocumentById and PutDocument.

drmarjanovic · 2022-11-24T09:49:06Z

modules/library/src/main/scala/zio/elasticsearch/ElasticRequest.scala

+    doc: A,
+    routing: Option[Routing] = None
+  )(implicit schema: Schema[A]): ElasticRequest[Unit] =
+    Put(index, id, Document.apply(doc), routing)


You can omit .apply. You can use only Document(doc).

drmarjanovic · 2022-11-24T09:50:46Z

modules/library/src/main/scala/zio/elasticsearch/package.scala

@@ -1,11 +1,17 @@
 package zio

 import zio.schema.Schema
-import zio.schema.codec.DecodeError
+import zio.schema.codec.{DecodeError, JsonCodec}
 import zio.schema.codec.JsonCodec.JsonDecoder

 package object elasticsearch {
  private[elasticsearch] final case class Document(json: String) {


Maybe it makes sense to extract it out of the package object. Create a separate file called Document.

arnoldlacko · 2022-11-25T08:42:38Z

modules/library/src/main/scala/zio/elasticsearch/Document.scala

+}
+
+private[elasticsearch] object Document {
+  def apply[A](doc: A)(implicit schema: Schema[A]): Document = Document(


Please change to from

drmarjanovic

After we did some research we identified the following way to add documents to the Elasicsearch:

PUT /<index>/_doc/<id>
This endpoint either updates the document or creates a new one. However, note that we can provide op_type to create and change its behavior of it - it will only create a new document if does not exist or fail.
PUT/POST /<index>/_create/<id>
Creates a new document with a specified ID or fails.
POST <index>/_doc
Creates a new document with auto-generated ID.

Keeping this in mind, it makes sense to me to provide following public API in our library:

def create[A: Schema](index: IndexName, id: DocumentId, doc: A, ...)

def create[A: Schema](index: IndexName, doc: A, ...)

def upsert[A: Schema](index: IndexName, id: DocumentId, doc: A, ...)

Regarding our underlying types, we can go with two options:

Have both final case class Create(id: Option[DocumentId], ...) and final case class CreateOrUpdate(id: DocumentId, ...)`, and depending on that decide what should we do (in the Executor)
Have only `Put(id: Option[DocumentId], create: Boolean, ...)

drmarjanovic · 2022-11-27T15:58:38Z

modules/library/src/main/scala/zio/elasticsearch/ElasticRequest.scala

@@ -24,10 +24,40 @@ object ElasticRequest {
      case None           => Left(DocumentNotFound)
    }

+  def create[A: Schema](


I would add both:
create(index: IndexName, id: DocumentId, doc: A...)
and
create(index: IndexName, doc: A).

We are seeking to provide simpler public API and make our library usage easier, so it makes sense to provide rich public API.

arnoldlacko · 2022-11-27T17:28:25Z

modules/library/src/main/scala/zio/elasticsearch/Document.scala

+
+private[elasticsearch] object Document {
+  def from[A](doc: A)(implicit schema: Schema[A]): Document = Document(
+    JsonCodec.jsonEncoder(schema).encodeJson(a = doc, indent = None).toString


I would remove a = as it does not provide additional information.

Should 'indent' remain?

arnoldlacko reviewed Nov 24, 2022

View reviewed changes

modules/library/src/main/scala/zio/elasticsearch/ElasticRequest.scala Outdated Show resolved Hide resolved

drmarjanovic requested changes Nov 24, 2022

View reviewed changes

arnoldlacko reviewed Nov 25, 2022

View reviewed changes

dbulaja98 force-pushed the dsl-put-request branch from 92b8cfb to ff83908 Compare November 25, 2022 14:59

drmarjanovic requested changes Nov 27, 2022

View reviewed changes

arnoldlacko reviewed Nov 27, 2022

View reviewed changes

Base automatically changed from dsl-get-by-id-request to main November 28, 2022 08:51

dbulaja98 force-pushed the dsl-put-request branch from a51485a to 62d35c1 Compare November 28, 2022 08:54

drmarjanovic and others added 15 commits November 28, 2022 09:59

Provide initial getById Elasticsearch request

25b7547

Format code

b4f8cc9

Improve getById request

f6fdae8

Code cleanup

6df97b5

Refactor ElasticRequest

61af183

Add error message to JsonDecoderError

8374b3b

Rename 'Index' to 'IndexName'

08a0775

Extract elastic errors to a separated file

85ee8af

Provide initial put Elasticsearch request

adbfa88

Refactor put request

e7720b2

Move Document to separate file

23aa2b3

Rename apply to from in Document

fa53a1d

Divide put to create and upsert

ba20e40

Refactor code

85a902a

Add default routing for create with document id

12911f5

dbulaja98 force-pushed the dsl-put-request branch from 62d35c1 to 12911f5 Compare November 28, 2022 09:12

Reorganize methods

3387a17

drmarjanovic approved these changes Nov 28, 2022

View reviewed changes

drmarjanovic changed the title ~~(dsl): Support Put request~~ (dsl): Support create and upsert requests (#6) Nov 28, 2022

drmarjanovic changed the title ~~(dsl): Support create and upsert requests (#6)~~ (dsl): Support create and upsert requests Nov 28, 2022

drmarjanovic merged commit 85ee86f into main Nov 28, 2022

drmarjanovic deleted the dsl-put-request branch November 28, 2022 09:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(dsl): Support create and upsert requests #6

(dsl): Support create and upsert requests #6

dbulaja98 commented Nov 23, 2022

drmarjanovic Nov 23, 2022

drmarjanovic Nov 24, 2022

drmarjanovic Nov 24, 2022

arnoldlacko Nov 25, 2022

drmarjanovic left a comment

drmarjanovic Nov 27, 2022

arnoldlacko Nov 27, 2022

dbulaja98 Nov 27, 2022

(dsl): Support create and upsert requests #6

(dsl): Support create and upsert requests #6

Conversation

dbulaja98 commented Nov 23, 2022

drmarjanovic Nov 23, 2022

Choose a reason for hiding this comment

drmarjanovic Nov 24, 2022

Choose a reason for hiding this comment

drmarjanovic Nov 24, 2022

Choose a reason for hiding this comment

arnoldlacko Nov 25, 2022

Choose a reason for hiding this comment

drmarjanovic left a comment

Choose a reason for hiding this comment

drmarjanovic Nov 27, 2022

Choose a reason for hiding this comment

arnoldlacko Nov 27, 2022

Choose a reason for hiding this comment

dbulaja98 Nov 27, 2022

Choose a reason for hiding this comment