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 #1061

Closed
2 of 13 tasks
curquiza opened this issue Oct 19, 2021 · 3 comments
Closed
2 of 13 tasks

NDJSON/CSV methods to add and update documents #1061

curquiza opened this issue Oct 19, 2021 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@curquiza
Copy link
Member

curquiza commented Oct 19, 2021 •
edited by bidoubiwa
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, string csvDelimiter)
    • addDocumentsCsvInBatches(string docs, int batchSize, string primaryKey, string csvDelimiter)
    • 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, string csvDelimiter)
    • updateDocumentsCsvInBatches(string docs, int batchSize, string primaryKey, string csvDelimiter)
    • 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
@Sukriti-sood
Copy link

@curquiza Can I work on this?

@curquiza
Copy link
Member Author

Thanks for your interest in this project :)

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 🙂

@Sukriti-sood Sukriti-sood mentioned this issue Oct 30, 2021
Closed
1 task
@brunoocasali brunoocasali mentioned this issue Feb 16, 2023
Closed
@bidoubiwa bidoubiwa mentioned this issue Apr 3, 2023
Merged
meili-bors bot added a commit that referenced this issue Apr 4, 2023
@meili-bors @bidoubiwa
Merge #1474
4664ed4 
1474: Add method to add/update documents from a string r=bidoubiwa a=bidoubiwa

Partial: #1061 

Introduces two methods on Index(): 
- `addDocumentsFromString`
- `updateDocumentsFromString` 

These allow the user to add documents using any of the following format: `csv`, `json` or `jsonld`.

They require 2 parameters and 1 optional parameter:
- the documents in a string
- the content type, either one of the following options:
   -  `'text/csv'` or `ContentType.CSV` in typescript
   - `'application/x-ndjson'` or `ContentType.NDJSON` in typescript
   - 'application/json' or `ContentType.JSON` in typescript
- The document addition options. for example the primary key

The content of the string must match its content-type. Only when using the `CSV` format it is possible to use `csvDelimiter`

Usage:

```ts
client.index('myIndex').addDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise<EnqueuedTask>
```

```ts
client.index('myIndex').updateDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise<EnqueuedTask>
```

### Example: 

https://github.com/meilisearch/meilisearch-js/blob/d948a7551108b18def7e1e69c05997c47b9ac2ae/tests/raw_document.test.ts#L164-L174



Co-authored-by: Charlotte Vermandel <[email protected]>
@bidoubiwa
Copy link
Contributor

Partially fixed by: #1474

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.

header for put and post Sukriti-sood/meilisearch-js
4 participants
@curquiza @bidoubiwa @Sukriti-sood @meili-bot