R: Ping a Solr instance

ping {solrium} | R Documentation

## Ping a Solr instance

### Description

Ping a Solr instance

### Usage

    ping(conn, name, wt = "json", raw = FALSE, ...)

### Arguments

`conn` | A solrium connection object, see SolrClient
`name` | (character) Name of a collection or core. Required.
`wt` | (character) One of json (default) or xml. If json, uses `jsonlite::fromJSON()` to parse. If xml, uses [xml2::read_xml)] to parse [xml2::read_xml)]: R:xml2::read_xml)
`raw` | (logical) If `TRUE`, returns raw data in format specified by `wt` param
`...` | curl options passed on to crul::HttpClient

### Details

You likely may not be able to run this function against many public Solr services as they hopefully don't expose their admin interface to the public, but works locally.

### Value

if `wt="xml"` an object of class `xml_document`, if `wt="json"` an object of class `list`

### Examples

    ## Not run:
    # start Solr, in your CLI, run: `bin/solr start -e cloud -noprompt`
    # after that, if you haven't run `bin/post -c gettingstarted docs/` yet,
    # do so

    # connect: by default we connect to localhost, port 8983
    (cli <- SolrClient$new())

    # ping the gettingstarted index
    cli$ping("gettingstarted")
    ping(cli, "gettingstarted")
    ping(cli, "gettingstarted", wt = "xml")
    ping(cli, "gettingstarted", verbose = FALSE)
    ping(cli, "gettingstarted", raw = TRUE)

    ping(cli, "gettingstarted", wt="xml", verbose = TRUE)

    ## End(Not run)

[Package solrium version 1.0.0 Index]