forked from invertase/tanstack-query-firebase
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(useConnectQuery): add useConnectQuery docs
- Loading branch information
1 parent
24f4731
commit 3af36ba
Showing
2 changed files
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: useConnectQuery | ||
--- | ||
|
||
`useConnectQuery` is a custom hook designed to simplify data fetching and state management with Firebase Data Connect. | ||
This hook integrates with[Firebase Data Connect](https://firebase.google.com/docs/data-connect), which leverages GraphQL to interact with a PostgreSQL database (via Cloud SQL) for secure, scalable data operations. | ||
The hook simplifies the process of querying data from Firebase Data Connect and provides an easy-to-use interface to manage loading, success, and error states in your React application. | ||
|
||
## Features | ||
|
||
- Provides type-safe handling of queries based on the Firebase Data Connect schema. | ||
- Simplifies data fetching using Firebase Data Connect. | ||
- Automatically manages loading, success, and error states. | ||
- Supports refetching data with integrated caching. | ||
|
||
## Usage | ||
|
||
```jsx | ||
import { useConnectQuery } from "./useConnectQuery"; | ||
import { listMoviesQuery } from "@/your-package-name/your-connector"; | ||
|
||
function Component() { | ||
const { data, isPending, isSuccess, isError, error } = useConnectQuery( | ||
listMoviesQuery() | ||
); | ||
|
||
if (isPending) return <div>Loading...</div>; | ||
if (isError) return <div>Error: {error.message}</div>; | ||
|
||
return ( | ||
<div> | ||
{isSuccess && ( | ||
<ul> | ||
{data.movies.map((movie) => ( | ||
<li key={movie.id}>{movie.title}</li> | ||
))} | ||
</ul> | ||
)} | ||
</div> | ||
); | ||
} | ||
``` |