github.com/pluswing/datasync@v1.1.1-0.20240218052257-9077f6fc4ae3/README.md (about)

     1  # DataSync
     2  [English](https://github.com/pluswing/datasync/blob/develop/README.md) [日本語](https://github.com/pluswing/datasync/blob/develop/README_ja.md)
     3  
     4  A database sharing tool for developers
     5  
     6  ## What is this?
     7  Have you ever needed to share the contents of a database with your team members during development work?
     8  DataSync solves a common problem faced by developers.
     9  Creating backups of databases, sharing them, and applying them can be cumbersome, time-consuming, and often complex.
    10  Using DataSync, these processes become simple and efficient.
    11  For example, you can easily pass on data needed for testing new features or reproducing bugs to your team members.
    12  This speeds up the development cycle and allows you to focus on more productive activities.
    13  
    14  ## Overview
    15  DataSync is a tool that enables backup, history management, and quick application of any backup for MySQL and files.
    16  
    17  Key features include:
    18  
    19  - Backup of databases and files
    20  - History management of backups
    21  - Application of any backup
    22  - Easy sharing and retrieval of backups through integration with cloud storage
    23  
    24  ## Examples of Use
    25  
    26  ### Executing a Backup
    27  
    28  ```
    29  $ datasync dump -m "feature_test"
    30  ✔️ mysql dump completed (database: sample)
    31  ✔︎ compress data completed.
    32  Dump succeeded. Version ID = 35ca8d497d334891b2ff627174a2b88a
    33  ```
    34  
    35  ### Listing Backups
    36  ```
    37  $ datasync ls -a
    38  -- Remote versions --
    39  224120fe68d14f6eaf2b4ea0533c497f 2024-01-30 13:53:21 test001
    40  -- local versions --
    41  35ca8d497d334891b2ff627174a2b88a 2024-02-10 09:33:27 test002
    42  ```
    43  
    44  ### Applying a Backup
    45  ```
    46  $ datasync apply 35ca8d4
    47  ✔︎ decompress data completed.
    48  ✔︎ mysql import completed (database: sample)
    49  Apply succeeded. Version ID = 35ca8d497d334891b2ff627174a2b88a
    50  ```
    51  
    52  ### Sending a Backup to the Cloud
    53  ```
    54  $ datasync push
    55  ```
    56  
    57  ### Retrieving a Backup from the Cloud
    58  ```
    59  $ datasync pull
    60  ```
    61  
    62  ## Installation
    63  DataSync is a standalone single-file binary. Please follow the steps below:
    64  
    65  1. Download the latest DataSync from the [Releases page](https://github.com/pluswing/datasync/releases).
    66  2. Save the downloaded file to any location.
    67  3. Move to the location where you saved the file from the command line, and run the following command to initialize DataSync:
    68  ```
    69  datasync init
    70  ```
    71  Now, you are ready to go!
    72  
    73  ## License
    74  MIT License