mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 10:25:06 +03:00
## What kind of change does this PR introduce? Docs update. Aligns documentation and style guides with the **Sign in / Sign out / Sign up** platform standard. Closes DOCS-1328. Related to [#49874](https://github.com/supabase/supabase/pull/49874). ## What is the current behavior? Docs style guides prefer _login_ / _log in_. Guide prose uses mixed login and sign in wording. ## What is the new behavior? - [WORD_LIST.md](apps/docs/WORD_LIST.md) and [copywriting.mdx](apps/design-system/content/docs/copywriting.mdx) document the sign in standard - Design-system auth examples updated - Guide prose and API reference spec descriptions updated ### Terminology **Standard:** Use _sign in_, _sign out_, and _sign up_ as verbs. Use _sign-in_, _sign-out_, and _sign-up_ as nouns and adjectives. Match Studio UI labels (**Sign in**, **Sign out**, **Sign up**). **Preserved intentionally:** | Category | Keep as-is | Example | | -------- | ---------- | ------- | | Feature name | social login | `/social-login`, `features.mdx` heading, OAuth provider section | | URL slugs | `login` in paths | `/phone-login`, `/login-flows`, `choosing-login-flow` | | CLI | `supabase login` / `supabase logout` | Reference ids `supabase-login` / `supabase-logout`; executable commands unchanged | | SDK methods | `logout()` | Kotlin/Swift method names in API reference titles and examples | | Third-party UI | Provider product labels | Facebook Login, Kakao Login, portal **Login** buttons | | Postgres | Database terminology | login privileges, login credentials, login via role | | Audit/logging | Log prose | "Generates the following **log** in the Postgres Logs" | | Code and routes | Paths and filenames | `app/login/`, `Login.tsx`, `demos/android-login` | | External URLs | Third-party login pages | `dash.cloudflare.com/login`, `console.neon.tech/login`, `vercel.com/login` | | API identifiers | Event and field names | Audit actions `login`/`logout`, `should_logout_user` | ## To test - Run `pnpm lint:mdx` in `apps/docs` - Spot-check `features.mdx`, `social-login.mdx`, and a provider guide (e.g. Facebook, Kakao) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized authentication terminology across guides, reference material, CLI documentation, and copywriting guidance using “sign in,” “sign out,” and “sign up.” * Updated authentication instructions, headings, link text, examples, and SSO guidance for clearer, more consistent wording. * Corrected related grammar, spelling, hyphenation, and documentation links while preserving established product names and implementation commands. * **Style** * Refined code examples with consistent import ordering and spacing. * **Examples** * Updated authentication button and menu labels to “Sign in” and “Sign out.” <!-- end of auto-generated comment: release notes by coderabbit.ai -->
112 lines
3.2 KiB
Plaintext
112 lines
3.2 KiB
Plaintext
---
|
|
id: 'storage-management'
|
|
title: 'Copy Objects'
|
|
description: 'Learn how to copy and move objects'
|
|
subtitle: 'Learn how to copy and move objects'
|
|
sidebar_label: 'Copy / Move Objects'
|
|
---
|
|
|
|
## Copy objects
|
|
|
|
You can copy objects between buckets or within the same bucket. Currently only objects up to 5 GB can be copied using the API.
|
|
|
|
When making a copy of an object, the owner of the new object will be the user who initiated the copy operation.
|
|
|
|
### Copying objects within the same bucket
|
|
|
|
To copy an object within the same bucket, use the `copy` method.
|
|
|
|
```javascript
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
const supabase = createClient('your_project_url', 'your_supabase_api_key')
|
|
|
|
// ---cut---
|
|
await supabase.storage.from('avatars').copy('public/avatar1.png', 'private/avatar2.png')
|
|
```
|
|
|
|
### Copying objects across buckets
|
|
|
|
To copy an object across buckets, use the `copy` method and specify the destination bucket.
|
|
|
|
```javascript
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
const supabase = createClient('your_project_url', 'your_supabase_api_key')
|
|
|
|
// ---cut---
|
|
await supabase.storage.from('avatars').copy('public/avatar1.png', 'private/avatar2.png', {
|
|
destinationBucket: 'avatars2',
|
|
})
|
|
```
|
|
|
|
## Move objects
|
|
|
|
You can move objects between buckets or within the same bucket. Currently only objects up to 5GB can be moved using the API.
|
|
|
|
When moving an object, the owner of the new object will be the user who initiated the move operation. Once the object is moved, the original object will no longer exist.
|
|
|
|
### Moving objects within the same bucket
|
|
|
|
To move an object within the same bucket, you can use the `move` method.
|
|
|
|
```javascript
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
const supabase = createClient('your_project_url', 'your_supabase_api_key')
|
|
|
|
// ---cut---
|
|
const { data, error } = await supabase.storage
|
|
.from('avatars')
|
|
.move('public/avatar1.png', 'private/avatar2.png')
|
|
```
|
|
|
|
### Moving objects across buckets
|
|
|
|
To move an object across buckets, use the `move` method and specify the destination bucket.
|
|
|
|
```javascript
|
|
import { createClient } from '@supabase/supabase-js'
|
|
|
|
const supabase = createClient('your_project_url', 'your_supabase_api_key')
|
|
|
|
// ---cut---
|
|
await supabase.storage.from('avatars').move('public/avatar1.png', 'private/avatar2.png', {
|
|
destinationBucket: 'avatars2',
|
|
})
|
|
```
|
|
|
|
## Permissions
|
|
|
|
To **copy** objects, users need `select` permission on the source object and `insert` permission on the destination object. If the user also has `update` permission, the copy can be performed as an upsert, which will overwrite the destination object if it already exists.
|
|
|
|
To **move** objects, users need `select` and `update` permissions on the object.
|
|
|
|
For example:
|
|
|
|
```sql
|
|
create policy "User can select their own objects (in any buckets)"
|
|
on storage.objects
|
|
for select
|
|
to authenticated
|
|
using (
|
|
owner_id = (select auth.uid())
|
|
);
|
|
|
|
create policy "User can insert in their own folders (in any buckets)"
|
|
on storage.objects
|
|
for insert
|
|
to authenticated
|
|
with check (
|
|
(storage.foldername(name))[1] = (select auth.uid())
|
|
);
|
|
|
|
create policy "User can update their own objects (in any buckets)"
|
|
on storage.objects
|
|
for update
|
|
to authenticated
|
|
using (
|
|
owner_id = (select auth.uid())
|
|
);
|
|
```
|