TinyBase logoTinyBase β

Queries primitives

useResultTable

The useResultTable primitive returns an object containing the entire data of the ResultTable of the given query, and registers a listener so that any changes to that result will cause an update. Read more.

useResultTableCellIds

The useResultTableCellIds primitive returns the Ids of every Cell used across the whole ResultTable of the given query, and registers a listener so that any changes to those Ids will cause an update. Read more.

useResultTableCellIdsListener

The useResultTableCellIdsListener primitive registers a listener function with a Queries object that will be called whenever the Cell Ids that appear anywhere in a ResultTable change. Read more.

useResultTableListener

The useResultTableListener primitive registers a listener function with a Queries object that will be called whenever data in a ResultTable changes. Read more.

useResultRowIds

The useResultRowIds primitive returns the Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause an update. Read more.

useResultRowIdsListener

The useResultRowIdsListener primitive registers a listener function with a Queries object that will be called whenever the Row Ids in a ResultTable change. Read more.

useResultSortedRowIds

The useResultSortedRowIds primitive returns the sorted (and optionally, paginated) Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause an update. Read more.

useResultSortedRowIdsListener

The useResultSortedRowIdsListener primitive registers a listener function with a Queries object that will be called whenever the sorted (and optionally, paginated) Row Ids in a ResultTable change. Read more.

useResultRow

The useResultRow primitive returns an object containing the data of a single Row in the ResultTable of the given query, and registers a listener so that any changes to that Row will cause an update. Read more.

useResultRowCount

The useResultRowCount primitive returns the count of the Row objects in the ResultTable of the given query, and registers a listener so that any changes to that result will cause an update. Read more.

useResultRowCountListener

The useResultRowCountListener primitive registers a listener function with a Queries object that will be called whenever the count of ResultRow objects in a ResultTable changes. Read more.

useResultRowListener

The useResultRowListener primitive registers a listener function with a Queries object that will be called whenever data in a result Row changes. Read more.

useResultCellIds

The useResultCellIds primitive returns the Ids of every Cell in a given Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause an update. Read more.

useResultCellIdsListener

The useResultCellIdsListener primitive registers a listener function with a Queries object that will be called whenever the Cell Ids in a result Row change. Read more.

useResultCell

The useResultCell primitive returns the value of a single Cell in a given Row in the ResultTable of the given query, and registers a listener so that any changes to that value will cause an update. Read more.

useResultCellListener

The useResultCellListener primitive registers a listener function with a Queries object that will be called whenever data in a Cell changes. Read more.

useParamValues

The useParamValues primitive returns an object containing all the parameter values currently set for a query. Read more.

useParamValuesListener

The useParamValuesListener primitive registers a listener function with a Queries object that will be called whenever the parameter values for a query change. Read more.

useSetParamValuesCallback

The useSetParamValuesCallback primitive returns a parameterized callback that can be used to set multiple parameter values for a query at once. Read more.

useParamValue

The useParamValue primitive returns the current value of a single parameter in a query. Read more.

useParamValueListener

The useParamValueListener primitive registers a listener function with a Queries object that will be called whenever a single parameter value for a query changes. Read more.

useSetParamValueCallback

The useSetParamValueCallback primitive returns a parameterized callback that can be used to set a single parameter value for a query. Read more.

useCreateQueries

The useCreateQueries primitive is used to create a Queries object within a Solid application with convenient memoization. Read more.

useProvideQueries

The useProvideQueries primitive is used to add a Queries object by Id to a Provider component, but imperatively from a component within it. Read more.

useQueries

The useQueries primitive is used to get a reference to a Queries object from within a Provider component context. Read more.

useQueriesIds

The useQueriesIds primitive is used to retrieve the Ids of all the named Queries objects present in the current Provider component context. Read more.

useQueriesOrQueriesById

The useQueriesOrQueriesById primitive is used to get a reference to a Queries object from within a Provider component context, or have it passed directly to this primitive. Read more.

useQueryIds

The useQueryIds primitive gets an array of the Query Ids registered with a Queries object, and registers a listener so that any changes to that result will cause an update. Read more.