NDJSON/CSV methods to add and update documents

[curquiza]

⚠️ This issue is generated, it means the nameing might be done differently in this package (ex: add_documents_json instead of addDocumentsJson). Keep the already existing way of naming in this package to stay idiomatic with the language and this repository.

📣 We strongly recommend doing multiple PRs to solve all the points of this issue

MeiliSearch v0.23.0 introduces two changes:

• new valid formats to push data files, additionally to the JSON format: CSV and NDJSON formats.
• it enforces the Content-type header for every route requiring a payload (POST and PUT routes)

---

Here are the expected changes to completely close the issue:

• Currently, the SDKs always send Content-Type: application/json to every request. Only the POST and PUT requests should send the Content-Type: application/json and not the DELETE and GET ones.

• Add the following methods and 🔥 the associated tests 🔥 to ADD the documents. Depending on the format type (csv or ndjson) the SDK should send Content-Type: application/x-dnjson or Content-Type: text/csv)

  • addDocumentsJson(string docs, string primaryKey)
  • addDocumentsCsv(string docs, string primaryKey)
  • addDocumentsCsvInBatches(string docs, int batchSize, string primaryKey)
  • addDocumentsNdjson(string docs, string primaryKey)
  • addDocumentsNdjsonInBatches(string docs, int batchSize, string primaryKey)

• Add the following methods and 🔥 the associated tests 🔥 to UPDATE the documents. Depending on the format type (csv or ndjson) the SDK should send Content-Type: application/x-dnjson or Content-Type: text/csv)

  • updateDocumentsJson(string docs, string primaryKey)
  • updateDocumentsCsv(string docs, string primaryKey)
  • updateDocumentsCsvInBatches(string docs, int batchSize, string primaryKey)
  • updateDocumentsNdjson(string docs, string primaryKey)
  • updateDocumentsNdjsonInBatches(string docs, int batchSize, string primaryKey)

docs are the documents sent as String
primaryKey is the primary key of the index
batchSize is the size of the batch. Example: you can send 2000 documents in raw String in docs and ask for a batchSize of 1000, so your documents will be sent to MeiliSearch in two batches.

Example of PRs:

• in PHP SDK: News methods New format handling CSV NDJSON meilisearch-php#235
• in Python SDK: New format handling CSV NDJSON meilisearch-python#329

---

Related to: meilisearch/integration-guides#146

If this issue is partially/completely implemented, feel free to let us know.

EDIT:

The files needed for the tests when creating the csv and ndjson methods are available here:

• songs.csv
• songs.ndjson

[iverburgh]

Currently working on this issue

[curquiza]

Hello @iverburgh

Thanks for your interest in this project :)

Just FYI, we prefer not assigning people to our issues because sometimes people ask to be assigned and never come back, which discourages the volunteer contributors to open a PR to fix this issue.
We will accept and merge the first PR that fixes correctly and well implements the issue following our contributing guidelines.

We are looking forward to reviewing your PR 🙂

[juchom]

Hello @curquiza

I'm having a look at this issue and the first item to fix it this one

Currently, the SDKs always send Content-Type: application/json to every request. Only the POST and PUT requests should send the Content-Type: application/json and not the DELETE and GET ones.

Can you point me some code where GET or DELETE calls are sending Content-Type ?

I runned the tests with Fiddler and I have this for the calls I have checked :

GET

DELETE

[curquiza]

Hello @juchom

sorry it's indeed not the case sorry! It has been fixed!

[alallema]

Well Done @juchom 🎉