TinyBase logoTinyBase β

useIndexesOrIndexesById

The useIndexesOrIndexesById primitive is used to get a reference to an Indexes object from within a Provider component context, or have it passed directly to this primitive.

useIndexesOrIndexesById(indexesOrIndexesId?: MaybeAccessor<undefined | IndexesOrIndexesId>): Accessor<Indexes | undefined>
TypeDescription
indexesOrIndexesId?MaybeAccessor<undefined | IndexesOrIndexesId>

Either an Id for accessing an Indexes object that was named with an Id in the Provider, or the Indexes object itself.

returnsAccessor<Indexes | undefined>

A reference to the Indexes object (or undefined if not within a Provider context, or if the requested Indexes object does not exist).

This is mostly of use when you are developing a component that needs an Indexes object and which might have been passed in explicitly to the component or is to be picked up from the context by Id (a common pattern for Indexes-based components).

This primitive is unlikely to be used often. For most situations, you will want to use the useIndexes primitive.

Example

This example creates the TinyBase objects needed by the Solid primitive or component and calls it from within a reactive root.

import {createRoot} from 'solid-js';
import {
  createCheckpoints,
  createIndexes,
  createMetrics,
  createQueries,
  createRelationships,
  createStore,
} from 'tinybase';
import {useIndexesOrIndexesById} from 'tinybase/ui-solid';

createRoot((dispose) => {
  const store = createStore()
    .setTables({
      pets: {
        fido: {species: 'dog', color: 'brown', next: 'felix'},
        felix: {species: 'cat', color: 'black'},
      },
      species: {dog: {price: 5}, cat: {price: 4}},
    })
    .setValues({open: true});
  const metrics = createMetrics(store).setMetricDefinition(
    'highestPrice',
    'species',
    'max',
    'price',
  );
  const indexes = createIndexes(store).setIndexDefinition(
    'bySpecies',
    'pets',
    'species',
  );
  const relationships = createRelationships(store)
    .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    .setRelationshipDefinition('nextPet', 'pets', 'pets', 'next');
  const queries = createQueries(store).setQueryDefinition(
    'petColors',
    'pets',
    ({select, where, param}) => {
      select('color');
      where((getCell) => getCell('species') == param('species'));
    },
    {species: 'dog'},
  );
  const checkpoints = createCheckpoints(store);
  store.setCell('pets', 'fido', 'color', 'walnut');
  checkpoints.setCheckpoint('updated color');
  metrics.getMetric('highestPrice');
  indexes.getSliceIds('bySpecies');
  relationships.getRemoteRowId('petSpecies', 'fido');
  queries.getResultRowIds('petColors');
  useIndexesOrIndexesById(indexes);
  dispose();
});

Since

v8.3.0