https://github.com/honorablecon/supabackup

Supabackup is a node package, that allows you to easily perform your supabase backup operations for free. This package creates a backup of your given database tables.
https://github.com/honorablecon/supabackup

collaborate

Last synced: 2 months ago
JSON representation

Supabackup is a node package, that allows you to easily perform your supabase backup operations for free. This package creates a backup of your given database tables.

• Host: GitHub
• URL: https://github.com/honorablecon/supabackup
• Owner: honorableCon
• Created: 2022-01-29T18:38:48.000Z (almost 3 years ago)
• Default Branch: feature/package
• Last Pushed: 2022-02-07T23:04:45.000Z (almost 3 years ago)
• Last Synced: 2024-10-15T15:16:41.601Z (3 months ago)
• Topics: collaborate
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SUPABACKUP 

[![Made-In-Senegal](https://github.com/GalsenDev221/made.in.senegal/blob/master/assets/badge.svg)](https://github.com/GalsenDev221/made.in.senegal) 

Supabackup is a node package, that allows you to easily perform your supabase backup (restore) operations for free.


This package creates a backup of your given database tables. 


The backup is stored on your supabase storage. (in json format) 


You can add this on your administration interface to add backup feature.




# Getting Started

## Installation 📥 

Make sure you have Node, Npm already installed in your system. you can check if Node, Npm available in your system by running below command,

```

node -v

npm -v

```

If it's not installed in your system then please install them by checking official documentation of,

- https://nodejs.org/en/

After that, Install Package with below command :

```

npm install supabackup

```




# Usage ✅

## Initializing 

You can initialize a new Supabackup client using the initializeClient() method.

It's allow you to configure your backup.

### Parameters

1. supabaseUrl `required` `string`

      > The unique Supabase URL which is supplied when you create a new project in your project dashboard.

2. supabaseServiceKey `required` `string`

      > You can find the SERVICE_KEY on :

      > Setings > (project setings) API > `service_role` `secret` click on `reveal` and copy the key

### Example 💛

#### initializeClient()

```javascript

import { initializeClient } from 'supabackup'

// Create a single supabase client for interacting with your database 

const supabackup = initializeClient('https://xyzcompany.supabase.co', 'service-key')

```




## Backing up

You can make a new backup of your database using the backup() method.

### Parameters

1. supabackupClient `required` 

      > create with `initializeClient()`

2. bucket `string` `required` 

      > name that you give to your bucket (storage container)

3. tables `required` `array(string)` 

      > array of tables that you want to backup

### Example 💛

#### backup()

```javascript

import { initializeClient, backup } from 'supabackup'

// Create a single supabase client for interacting with your database 

const supabackup = initializeClient('https://xyzcompany.supabase.co', 'service-key')

// Backup the given tables (chat, user) on the bucket (Backup Chat)

backup(supabackup, "Backup Chat", ['user', 'chat']);

```

You can found the backup : `storage > Backup Chat > Backup [Date]`




## Restoring

You can your database using the restore() method.

### Parameters

1. supabackupClient `required` 

      > create with `initializeClient()`

2. bucket `string` `required` 

      > name that you give to your bucket (storage container)

3. folder `string` `required` 

      > backup folder name that you can find in your bucket

      > example : "Backup [Date backup]"

4. tables `required` `array(string)` 

      > array of tables that you want to backup

### Example 💛

#### backup()

```javascript

import { initializeClient, restore } from 'supabackup'

// Create a single supabase client for interacting with your database 

const supabackup = initializeClient('https://xyzcompany.supabase.co', 'service-key')

// Restore the given tables (chat, user) on the database

restore(

    supabackup, 

    "Backup", 

    'Backup 2022-01-30T13:48:12.589Z', 

    ['user', 'chat']

);

```

### Contributing 🤝

Bug reports and Pull Requests are welcome 👋🏽  

You can tell me on **[issues](https://github.com/honorableCon/supabackup/issues)**

### License 🔖

This project is under **[MIT License](https://opensource.org/licenses/MIT)**.