R: Delete documents by ID or query

delete {solrium} | R Documentation

## Delete documents by ID or query

### Description

Delete documents by ID or query

### Usage

    delete_by_id(conn, ids, name, commit = TRUE, commit_within = NULL,
      overwrite = TRUE, boost = NULL, wt = "json", raw = FALSE, ...)

    delete_by_query(conn, query, name, commit = TRUE, commit_within = NULL,
      overwrite = TRUE, boost = NULL, wt = "json", raw = FALSE, ...)

### Arguments

`conn` | A solrium connection object, see SolrClient
`ids` | Document IDs, one or more in a vector or list
`name` | (character) A collection or core name. Required.
`commit` | (logical) If `TRUE`, documents immediately searchable. Deafult: `TRUE`
`commit_within` | (numeric) Milliseconds to commit the change, the document will be added within that time. Default: `NULL`
`overwrite` | (logical) Overwrite documents with matching keys. Default: `TRUE`
`boost` | (numeric) Boost factor. Default: `NULL`
`wt` | (character) One of json (default) or xml. If json, uses `jsonlite::fromJSON()` to parse. If xml, uses `xml2::read_xml()` to parse
`raw` | (logical) If `TRUE`, returns raw data in format specified by `wt` param
`...` | curl options passed on to crul::HttpClient
`query` | Query to use to delete documents

### Details

We use json internally as data interchange format for this function.

### Examples

    ## Not run:
    (cli <- SolrClient$new())

    # add some documents first
    ss <- list(list(id = 1, price = 100), list(id = 2, price = 500))
    cli$add(ss, name = "gettingstarted")

    # Now, delete them
    # Delete by ID
    cli$delete_by_id(ids = 1, "gettingstarted")
    ## Many IDs
    cli$delete_by_id(ids = c(3, 4), "gettingstarted")

    # Delete by query
    cli$delete_by_query(query = "manu:bank", "gettingstarted")

    ## End(Not run)

[Package solrium version 1.0.0 Index]