Searchable

Interface for full-text searchable entities

Audience: Programmer

The Searchable interface is implemented by entities that support full-text search capabilities, enabling fast and flexible searching across multiple fields.

Fields

Field	Type	Description
searchableText	String!	Concatenated searchable content
searchRank	Float	Relevance score in search results
searchHighlight	String	Highlighted search matches

Search Capabilities

• Full-text search across multiple fields

• Fuzzy matching and typo tolerance

• Relevance ranking

• Faceted search

• Search suggestions

• Synonym support

Implementing Types

• InventoryItem (SKU, name, description)

• Customer (name, code, contact info)

• Supplier (name, code, products)

• PickingOrder (order number, customer)

• Product (name, description, attributes)

Usage

query {
  search(
    query: "wireless headphones"
    types: [INVENTORY_ITEM, PRODUCT]
    first: 10
  ) {
    edges {
      node {
        ... on Searchable {
          searchRank
          searchHighlight
        }
        ... on InventoryItem {
          id
          sku
          data
        }
      }
    }
    facets {
      field
      values {
        value
        count
      }
    }
  }
}

Advanced Search

query {
  inventoryItems(
    where: {
      searchableText_CONTAINS: "blue shirt"
      AND: {
        dataTypeSlug: "apparel"
      }
    }
    orderBy: {
      field: SEARCH_RANK
      direction: DESC
    }
  ) {
    edges {
      node {
        id
        sku
        searchRank
      }
    }
  }
}

Search Indexing

Searchable entities are indexed with:

• Automatic field extraction

• Custom weight configuration

• Language-specific analyzers

• Stop word filtering

• Stemming and lemmatization

Performance

• Indexed asynchronously

• Cached search results

• Pagination support

• Query optimization

• Result highlighting

Best Practices

1. Index only necessary fields

2. Configure field weights appropriately

3. Use search suggestions for UX

4. Implement search analytics

5. Monitor index size and performance

6. Consider search result caching

See Also

• InventoryItem Type - Searchable inventory

• Customer Type - Searchable customers

• Where Inputs - Search filters