PHPackages                             wearejh/stripped-db-provider - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. wearejh/stripped-db-provider

ActiveMagento2-module[Database & ORM](/categories/database)

wearejh/stripped-db-provider
============================

Stripped DB Provider for Magento 2

1.3.6(3mo ago)016.7k↓36.3%PHPPHP >=8.1.0

Since Sep 20Pushed 3mo ago5 watchersCompare

[ Source](https://github.com/WeareJH/stripped-db-provider)[ Packagist](https://packagist.org/packages/wearejh/stripped-db-provider)[ RSS](/packages/wearejh-stripped-db-provider/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (4)Versions (31)Used By (0)

Jh Stripped Db Provider
=======================

[](#jh-stripped-db-provider)

This module can be configured to automatically send stripped databases periodically into an Amazon S3 Bucket in the cloud.

Installation
------------

[](#installation)

Add the following repositories to the `repositories` section of your `composer.json`

```
{"type": "vcs", "url": "git@github.com:WeareJH/stripped-db-provider.git"},

```

Then install like any regular composer package

```
composer require wearejh/stripped-db-provider
```

Configuration
-------------

[](#configuration)

There are two areas of configuration. The first is project specific config, which is set in **config.php** and gets commited to the repository. The second is environment specific configuration which is added to the **env.php** file directly on the server.

### Project Specific Configuration

[](#project-specific-configuration)

All databases are stripped by default but you can define project specific tables whose data you wish to not be included in the dump by adding the following to your **config.php** file:

```
'system' => [
        'default' => [
            'stripped_db_provider' => [
                'dump' => [
                    'project_ignore_tables' => ['example_table_a', 'example_table_b']
                ]
            ]
        ]
    ]

```

Where `project_ignore_tables` is a list of project specfic tables.

### Environment Specific Configuration

[](#environment-specific-configuration)

Once Installed and deployed to production, you will want to configure it so that it automatically sends stripped DBs to the S3 Bucket. You would ned to add access\_key\_id & secret\_access\_key as encrypted value. So you can mention these values in admin which will auto encrypt these values. Edit the **env.php** file manually and set the following config (values below are examples):

```
'system' => [
        'default' => [
            'stripped_db_provider' => [
                'general' => [
                    'enabled' => '1',
                    'project_name' => 'example-project',
                    'cron_expr' => '0 4 * * 0'
                ],
                'storage' => [
                    'bucket_name' => 'example-bucket-name',
                    'region' => 'example-bucket-region',
                    'access_key_id' => 'example-bucket-access-key',
                    'secret_access_key' => 'example-bucket-secret-access-key'
                ]
            ]
        ]
    ]

```

You can add access\_key\_id, secret\_access\_key, bucket\_name, region from admin also by logging in admin. Go to Store->Configuration->Advanced->Stripped DB Provider

Values are described in the following table:

configvalueenabledOne of {0,1}project-nameString. Unique name for the project (used to name the db dump)cron\_exprA valid cron expression. Eg. "0 0/5 \* \* \*"bucket\_nameString. AWS S3 Bucket nameregionString. AWS S3 Bucket regionaccess\_key\_idString. AWS S3 Bucket access key idsecret\_access\_keyString. AWS S3 Bucket secret access keyThe Amazon S3 Bucket Details should be in LastPass. Ask your fellow developers if you can't find it or need help setting up.

After you have edited the env.php file, run the following command immediately :

```
bin/magento app:config:import

```

Run upload manually
-------------------

[](#run-upload-manually)

You can also manually trigger the stripped database upload from the command line by running the following command :

```
bin/magento wearejh:stripped-db-provider:upload-to-remote

```

To do a full DB dump

```
bin/magento wearejh:stripped-db-provider:upload-to-remote --full

```

Import a remote dump locally
----------------------------

[](#import-a-remote-dump-locally)

You can use the module to import a dump from S3 directly to your local. It will back up your local admin accounts and reimport them

```
bin/magento wearejh:stripped-db-provider:import-from-remote PROJECT NAME

```

#### To skip admin accounts backup

[](#to-skip-admin-accounts-backup)

```
bin/magento wearejh:stripped-db-provider:import-from-remote PROJECT NAME --no-admin-backup=1

```

#### Config backup

[](#config-backup)

The `config-backup` option accepts 3 values:

- *skip* - skips the backup of local config and imports everything from the remote
- *merge* - backs up only the paths configured under `stripped_db_provider/dump/config_paths_keep` (accepts MySQL wildcards `%`), imports everything from the remote and merges the backed up config with the remote config
- *preserve-local* - backs up the whole `core_config_data` and restores it after the DB import from remote

```
bin/magento wearejh:stripped-db-provider:import-from-remote PROJECT NAME --config-backup=merge

```

Issues / Feature Request
------------------------

[](#issues--feature-request)

Please open github issues for any issues you encounter or feature requests you want to see. PRs are of course welcomed.

Troubleshooting
---------------

[](#troubleshooting)

If any project has 0.3.3 version installed of this module, getting a dependency error related to module: ifsnop/mysqldump-php ^2.12 while upgrading module to latest version then remove the below line from composer.json file of project root folder: { "type": "vcs", "url": ":maciejslawik/mysqldump-php.git" }

###  Health Score

53

—

FairBetter than 96% of packages

Maintenance78

Regular maintenance activity

Popularity26

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity78

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~102 days

Recently: every ~143 days

Total

24

Last Release

116d ago

Major Versions

0.3.3 → 1.02023-08-25

PHP version history (4 changes)0.1.0PHP ^7.1

0.3.3PHP ^7.1 || ^8.1.0

1.0PHP >=8.2.0

1.2.1PHP >=8.1.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/2a5332bef5dfe8c03f82f4a4c94586bf35b2ec82f5f1f050a39ec0aa694a8668?d=identicon)[jh](/maintainers/jh)

---

Top Contributors

[![maciejslawik](https://avatars.githubusercontent.com/u/11910648?v=4)](https://github.com/maciejslawik "maciejslawik (14 commits)")[![bartoszkubicki](https://avatars.githubusercontent.com/u/20238194?v=4)](https://github.com/bartoszkubicki "bartoszkubicki (9 commits)")[![JamelleG](https://avatars.githubusercontent.com/u/9504561?v=4)](https://github.com/JamelleG "JamelleG (7 commits)")[![megham2908](https://avatars.githubusercontent.com/u/149599506?v=4)](https://github.com/megham2908 "megham2908 (3 commits)")[![zaxkh](https://avatars.githubusercontent.com/u/42416834?v=4)](https://github.com/zaxkh "zaxkh (2 commits)")[![mikeymike](https://avatars.githubusercontent.com/u/2174476?v=4)](https://github.com/mikeymike "mikeymike (2 commits)")[![pknap](https://avatars.githubusercontent.com/u/1770746?v=4)](https://github.com/pknap "pknap (2 commits)")[![radoslawniestroj](https://avatars.githubusercontent.com/u/47544358?v=4)](https://github.com/radoslawniestroj "radoslawniestroj (1 commits)")

---

Tags

db-dumpm2m2-module

### Embed Badge

![Health badge](/badges/wearejh-stripped-db-provider/health.svg)

```
[![Health](https://phpackages.com/badges/wearejh-stripped-db-provider/health.svg)](https://phpackages.com/packages/wearejh-stripped-db-provider)
```

###  Alternatives

[leantime/leantime

Open source project management system for non-project managers. Simple like Trello, powerful like Jira. Built with neurodiversity in mind.

10.2k3.5k](/packages/leantime-leantime)[baopham/dynamodb

Eloquent syntax for DynamoDB

4986.0M6](/packages/baopham-dynamodb)[pressbooks/pressbooks

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS.

45444.2k1](/packages/pressbooks-pressbooks)[ellaisys/aws-cognito

Laravel Authentication using AWS Cognito (Web and API)

123256.9k1](/packages/ellaisys-aws-cognito)[altis/core

Core module for Altis

19228.0k3](/packages/altis-core)[keboola/storage-api-client

Keboola Storage API PHP Client

10405.9k40](/packages/keboola-storage-api-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)