Skip to content

v1.13: Proxy search requests #3136

Closed
@guimachiavelli

Description

@guimachiavelli
  • Part of efforts toward sharding, which is required when dealing with really big databases
  • New endpoints: GET /network and PATCH /network
    • Use it to set a self and one or more remotes
    • self is a string and indicates the name of the current machine/instance/node
    • remotes is an object containing remote objects. Remote objects consist of a name (the object key) and two values (url and searchApiKey)
  • New /multi-search parameters: federationOptions.remote and federationOptions.queryPosition
    • queryPosition should not be set manually (not sure why this is exposed on the request then?)
    • remote accepts a string, specifies which remote instance should run that specific query instead of self
  • Summarized workflow:
    1. Set self
    2. Set one or more remotes
    3. Query /multi-search setting federationOptions.remote for one or more queries

Tasks

  • Create: /reference/api/network
    • GET
    • PATCH
  • Update: /reference/api/multi_search
    • Add federationOptions.remote
    • Add federationOptions.queryPosition
    • Add remoteErrors to response
  • Update: /reference/api/keys
    • Add new permissions
  • Update /reference/errors/overview
    • invalid_multi_search_query_position
    • invalid_multi_search_remote

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      v1.13: Proxy search requests · Issue #3136 · meilisearch/documentation