mirror of
https://github.com/supabase/supabase.git
synced 2026-06-22 16:19:32 +08:00
152 lines
3.7 KiB
Plaintext
152 lines
3.7 KiB
Plaintext
---
|
|
id: initializing
|
|
title: 'Initializing'
|
|
slug: initializing
|
|
custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1.yml
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs'
|
|
import TabItem from '@theme/TabItem'
|
|
|
|
You can initialize a new Supabase client using the `createClient()` method.
|
|
|
|
The Supabase client is your entrypoint to the rest of the Supabase functionality
|
|
and is the easiest way to interact with everything we offer within the Supabase ecosystem.
|
|
|
|
## Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">
|
|
supabaseUrl
|
|
</span>
|
|
<span className="method-list-item-label-badge required">
|
|
required
|
|
</span>
|
|
<span className="method-list-item-validation">
|
|
<code>string</code>
|
|
</span>
|
|
</h4>
|
|
<div class="method-list-item-description">
|
|
|
|
The unique Supabase URL which is supplied when you create a new project in your project dashboard.
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">
|
|
supabaseKey
|
|
</span>
|
|
<span className="method-list-item-label-badge required">
|
|
required
|
|
</span>
|
|
<span className="method-list-item-validation">
|
|
<code>string</code>
|
|
</span>
|
|
</h4>
|
|
<div class="method-list-item-description">
|
|
|
|
The unique Supabase Key which is supplied when you create a new project in your project dashboard.
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">
|
|
options
|
|
</span>
|
|
<span className="method-list-item-label-badge false">
|
|
optional
|
|
</span>
|
|
<span className="method-list-item-validation">
|
|
<code>SupabaseClientOptions</code>
|
|
</span>
|
|
</h4>
|
|
<div class="method-list-item-description">
|
|
|
|
No description provided.
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
## Examples
|
|
|
|
### createClient()
|
|
|
|
```js
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
// Create a single supabase client for interacting with your database
|
|
const supabase = createClient(
|
|
'https://xyzcompany.supabase.co',
|
|
'public-anon-key'
|
|
)
|
|
```
|
|
|
|
### With additional parameters
|
|
|
|
```js
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
const options = {
|
|
schema: 'public',
|
|
headers: { 'x-my-custom-header': 'my-app-name' },
|
|
autoRefreshToken: true,
|
|
persistSession: true,
|
|
detectSessionInUrl: true,
|
|
}
|
|
const supabase = createClient(
|
|
'https://xyzcompany.supabase.co',
|
|
'public-anon-key',
|
|
options
|
|
)
|
|
```
|
|
|
|
### API schemas
|
|
|
|
```js
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
// Provide a custom schema. Defaults to "public".
|
|
const supabase = createClient(
|
|
'https://xyzcompany.supabase.co',
|
|
'public-anon-key',
|
|
{
|
|
schema: 'other_schema',
|
|
}
|
|
)
|
|
```
|
|
|
|
By default the API server points to the `public` schema. You can enable other database schemas within the Dashboard.
|
|
Go to `Settings > API > Schema` and add the schema which you want to expose to the API.
|
|
|
|
Note: each client connection can only access a single schema, so the code above can access the `other_schema` schema but cannot access the `public` schema.
|
|
|
|
### Custom `fetch` implementation
|
|
|
|
```js
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
const supabase = createClient(
|
|
'https://xyzcompany.supabase.co',
|
|
'public-anon-key',
|
|
{
|
|
fetch: fetch.bind(globalThis),
|
|
}
|
|
)
|
|
```
|
|
|
|
`supabase-js` uses the [`cross-fetch`](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests,
|
|
but an alternative `fetch` implementation can be provided as an option.
|
|
This is most useful in environments where `cross-fetch` is not compatible (for instance Cloudflare Workers).
|