prorm API Reference
    Preparing search index...

    Interface SolrStoreOptions

    Connection options for SolrStore. Mirror the fields solr-client's createClient() accepts; the whole object is forwarded to solr.createClient(...), so any additional driver options (path, protocol, secure, bigint, etc.) pass straight through.

    interface SolrStoreOptions {
        host?: string;
        port?: string | number;
        core?: string;
        path?: string;
        protocol?: string;
        secure?: boolean;
        client?: SolrClientLike;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Any other option accepted by solr.createClient(...).

    Index
    host? port? core? path? protocol? secure? client?
    host?: string

    Solr host. Defaults to the driver's own default (127.0.0.1).

    port?: string | number

    Solr port. Defaults to the driver's own default (8983).

    core?: string

    The core (or SolrCloud collection) to target.

    path?: string

    Base path Solr is mounted under. Defaults to the driver's default (/solr).

    protocol?: string

    http or https.

    secure?: boolean

    Use HTTPS.

    client?: SolrClientLike

    A pre-built solr-client client. When provided, connect() skips the require('solr-client') / createClient() step and uses this instead - the injection point used by tests to supply a mock.

    Settings
    Member Visibility

    On This Page
    Properties