dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-10 20:05:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: add comments for deleted subscriptions

Browse Source
This commit is contained in:
Paul Copplestone committed 2021-01-17 15:01:58 +08:00
1 parent 17882f7325
commit 2ef4d8133a
3 files changed
+24 -14
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

web/docs/client/generating-types.mdx
+7 -7
View File
@@ -12,9 +12,9 @@ Supabase will soon release native type generators that dump your database types
## Usage with TypeScript
`supabase-js` ships with type definitions for usage with TypeScript and for convenient IntelliSense autocomplete and documentation in your editor.
`supabase-js` ships with type definitions for usage with TypeScript and for convenient IntelliSense auto-complete and documentation in your editor.
When using TypeScript, you can pass the type of database row as a type parameter to the `from` method to get better autocompletion support down the chain.
When using TypeScript, you can pass the type of database row as a type parameter to the `from` method to get better auto-completion support down the chain.
If you don't provide a type for the row you need to explicitly pass `from<any>('tableName')`.
```ts
@@ -25,13 +25,13 @@ type Message = {
user_id: string;
channel_id: number;
author: { username: string };
};
}
const response = await supabase
.from<Message>('messages') // Message maps to the type of the row in your database.
.select('*, author:user_id(username)')
.match({ channel_id: 2 }) // Your IDE will be able to help with automcompletion.
response.data // Response body will be of type Array<Message>.
.match({ channel_id: 2 }) // Your IDE will be able to help with auto-completion.
response.data // Response data will be of type Array<Message>.
// If you don't provide a type for the row you need to explicitly pass `from<any>('tableName')`.
const response = await supabase
@@ -51,10 +51,10 @@ The Swagger specification for your Supabase project can be accessed as follows:
https://your-project.supabase.co/rest/v1/?apikey=your-anon-key
```
Using the open source [swagger-to-ts](https://github.com/drwpow/openapi-typescript#%EF%B8%8F-reading-specs-from-remote-resource) tool you can generate your types and store them locally:
Using the open source [swagger-to-ts](https://github.com/manifoldco/swagger-to-ts#%EF%B8%8F-reading-specs-from-remote-resource) tool you can generate your types and store them locally:
```bash
npx openapi-typescript https://your-project.supabase.co/rest/v1/?apikey=your-anon-key --output types/supabase.ts
npx @manifoldco/swagger-to-ts https://your-project.supabase.co/rest/v1/?apikey=your-anon-key --output types/supabase.ts
```
**Note:** Do note that your local types won't automatically stay in sync with your database, so make sure to regenerate your types after your make changes to your database.
web/docs/client/subscribe.mdx
+4
View File
@@ -204,6 +204,8 @@ const mySubscription = supabase
### Listening to updates
By default Supabase will send only the updated record. If you want to receive the previous values as well you can
enable full replication for the table you are listening too: `alter table "your_table" replica identity full;`
<Tabs
@@ -237,6 +239,8 @@ const mySubscription = supabase
### Listening to deletes
By default Supabase not send deleted records. If you want to receive the deleted record you can
enable full replication for the table you are listening too: `alter table "your_table" replica identity full;`
<Tabs
web/spec/supabase.yml
+13 -7
View File
@@ -149,9 +149,9 @@ pages:
## Usage with TypeScript
`supabase-js` ships with type definitions for usage with TypeScript and for convenient IntelliSense autocomplete and documentation in your editor.
`supabase-js` ships with type definitions for usage with TypeScript and for convenient IntelliSense auto-complete and documentation in your editor.
When using TypeScript, you can pass the type of database row as a type parameter to the `from` method to get better autocompletion support down the chain.
When using TypeScript, you can pass the type of database row as a type parameter to the `from` method to get better auto-completion support down the chain.
If you don't provide a type for the row you need to explicitly pass `from<any>('tableName')`.
```ts
@@ -162,20 +162,20 @@ pages:
user_id: string;
channel_id: number;
author: { username: string };
};
}
const response = await supabase
.from<Message>('messages') // Message maps to the type of the row in your database.
.select('*, author:user_id(username)')
.match({ channel_id: 2 }); // Your IDE will be able to help with automcompletion.
response.body // Response body will be of type Array<Message>.
.match({ channel_id: 2 }) // Your IDE will be able to help with auto-completion.
response.data // Response data will be of type Array<Message>.
// If you don't provide a type for the row you need to explicitly pass `from<any>('tableName')`.
const response = await supabase
.from<any>('messages')
.select('*, author:user_id(username)')
.match({ channel_id: 2 });
response.body // Response body will be of type Array<any>.
.match({ channel_id: 2 })
response.data // Response data will be of type Array<any>.
```
### Generate database types from Swagger OpenAPI specification
@@ -713,6 +713,9 @@ pages:
# Not yet implemented
```
- name: Listening to updates
description: |
By default Supabase will send only the updated record. If you want to receive the previous values as well you can
enable full replication for the table you are listening too: `alter table "your_table" replica identity full;`
js: |
```js
const mySubscription = supabase
@@ -727,6 +730,9 @@ pages:
# Not yet implemented
```
- name: Listening to deletes
description: |
By default Supabase not send deleted records. If you want to receive the deleted record you can
enable full replication for the table you are listening too: `alter table "your_table" replica identity full;`
js: |
```js
const mySubscription = supabase