Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NDJSON/CSV methods to add and update documents #238

Closed
13 tasks done
curquiza opened this issue Oct 19, 2021 · 2 comments · Fixed by #399
Closed
13 tasks done

NDJSON/CSV methods to add and update documents #238

curquiza opened this issue Oct 19, 2021 · 2 comments · Fixed by #399
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@curquiza
Copy link
Member

curquiza commented Oct 19, 2021 •
edited by brunoocasali
Loading

⚠️ 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:

Related to: meilisearch/integration-guides#146

If this issue is partially/completely implemented, feel free to let us know.
@curquiza curquiza added hacktoberfest good first issue Good for newcomers enhancement New feature or request labels Oct 19, 2021
@brunoocasali
Copy link
Member

Closed by #235

@brunoocasali
Copy link
Member

Sorry, my bad!

@brunoocasali brunoocasali reopened this Apr 27, 2022
@karlomikus karlomikus mentioned this issue Oct 14, 2022
Merged
3 tasks
bors bot added a commit that referenced this issue Oct 24, 2022
@bors @karlomikus
Merge #399
e2f8210 
399: Implement methods for CSV and Ndjson batch adds r=brunoocasali a=karlomikus

# Pull Request

## Related issue
Fixes #238

## What does this PR do?
- Implements methods for batch adding of documents in csv and ndjson format

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

## Notes
This is using `preg_split` and `implode` to chunk strings by newline. Let me know if there is a better way to do this.

If this is fine I can implement the rest of the methods from the issue.

Co-authored-by: Karlo Mikuš <[email protected]>
bors bot added a commit that referenced this issue Oct 25, 2022
@bors @karlomikus
Merge #399
64401af 
399: Implement methods for CSV and Ndjson batch adds r=brunoocasali a=karlomikus

# Pull Request

## Related issue
Fixes #238

## What does this PR do?
- Implements methods for batch adding of documents in csv and ndjson format

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

## Notes
This is using `preg_split` and `implode` to chunk strings by newline. Let me know if there is a better way to do this.

If this is fine I can implement the rest of the methods from the issue.

Co-authored-by: Karlo Mikuš <[email protected]>
@bors bors bot closed this as completed in 74df330 Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Implement methods for CSV and Ndjson batch adds karlomikus/meilisearch-php
3 participants
@brunoocasali @curquiza @meili-bot