cookbook 'sqitch', '~> 1.1.0'
The sqitch cookbook has been deprecated
Author provided reason for deprecation:
The sqitch cookbook has been deprecated and is no longer being maintained by its authors. Use of the sqitch cookbook is no longer recommended.
sqitch (2) Versions 1.1.0 Follow0
Installs sqitch for managing SQL changesets
cookbook 'sqitch', '~> 1.1.0', :supermarket
knife supermarket install sqitch
knife supermarket download sqitch
sqitch cookbook
This cookbook installs sqitch, a database-agnostic change management system. It also provides LWRPs for using Sqitch to deploy database schema changes.
Features
-
sqitch
LWRP with support for deploying and reverting schema changes -
why-run
support, indicating which changesets (if any) would be deployed
Tested on PostgreSQL. Theoretically supports SQLite, Oracle, and MySQL as well, but is untested for those platforms.
Requirements
Platforms
- Debian/Ubuntu
- RHEL/CentOS/Scientific/Amazon/Oracle
Chef
- Chef 12.1+
Cookbooks
- perl
- build-essential
Usage
In general, you should just use the sqitch
LWRP (it will automatically include the recipe that installs Sqitch, so you don't need to worry about that).
For example, to deploy version 2.0.0 of the myface
schema, you could do:
sqitch "myface_schema" do
action :deploy
db_name "myface_db"
to_target "2.0.0"
top_dir "/path/to/myface/sqitch/dir"
end
Similarly, to roll back to version 1.5.0, you might have:
sqitch "myface_schema" do
action :revert
db_name "myface_db"
to_target "1.5.0"
top_dir "/path/to/myface/sqitch/dir"
end
Please consult the documentation in /resources/default.rb
for complete details on the LWRP.
Attributes
-
node['sqitch']['engine']
Controls which driver module is installed, as well as which one is used by the LWRP. Defaults topg
for PostgreSQL.
Recipes
-
default
- Installs Sqitch, as well as necessary driver modules for the databases it supports.
Documentation
Additional documentation can be generated using [Yard].
bundle install
rake yard
You can view the documentation in your browser by running a yard server:
yard server --reload -B localhost --plugin yard-chef
License & Authors
Author: Cookbook Engineering Team (cookbooks@chef.io)
Copyright: 2008-2016, Chef Software, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
perl >= 1.0.0 |
build-essential >= 5.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
sqitch Cookbook CHANGELOG
This file is used to list changes made in each version of the sqitch cookbook.
1.1.0 (2018-07-24)
- Fix install failures on debian platforms
- Test with Local Delivery instead of Rake and cleanup platforms we test on
- Update apache2 license string in the metadata
- Update copyrights
- Add supports 'all' to the metadata
- Disable FC113 for now
- Require build_essential 5.0 and use the resource directly for Chef 14+ users
v1.0.0 (2016-09-16)
- Require Chef 12.1
- Require build-essential cookbook
v0.6.0 (2016-07-13)
PR #3 - Include mysql support josephholsten
Collaborator Number Metric
1.1.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
1.1.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): sqitch/resources/default.rb: 1
Chef/Deprecations/UseInlineResourcesDefined: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_useinlineresourcesdefined): sqitch/providers/default.rb: 14
Chef/Modernize/FoodcriticComments: Remove legacy code comments that disable Foodcritic rules (https://docs.chef.io/workstation/cookstyle/chef_modernize_foodcriticcomments): sqitch/providers/default.rb: 14
Chef/Modernize/WhyRunSupportedTrue: whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+ (https://docs.chef.io/workstation/cookstyle/chef_modernize_whyrunsupportedtrue): sqitch/providers/default.rb: 10
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.0 failed this metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
1.1.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): sqitch/resources/default.rb: 1
Chef/Deprecations/UseInlineResourcesDefined: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_useinlineresourcesdefined): sqitch/providers/default.rb: 14
Chef/Modernize/FoodcriticComments: Remove legacy code comments that disable Foodcritic rules (https://docs.chef.io/workstation/cookstyle/chef_modernize_foodcriticcomments): sqitch/providers/default.rb: 14
Chef/Modernize/WhyRunSupportedTrue: whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+ (https://docs.chef.io/workstation/cookstyle/chef_modernize_whyrunsupportedtrue): sqitch/providers/default.rb: 10
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.0 failed this metric
Chef/Deprecations/UseInlineResourcesDefined: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_useinlineresourcesdefined): sqitch/providers/default.rb: 14
Chef/Modernize/FoodcriticComments: Remove legacy code comments that disable Foodcritic rules (https://docs.chef.io/workstation/cookstyle/chef_modernize_foodcriticcomments): sqitch/providers/default.rb: 14
Chef/Modernize/WhyRunSupportedTrue: whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+ (https://docs.chef.io/workstation/cookstyle/chef_modernize_whyrunsupportedtrue): sqitch/providers/default.rb: 10
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
1.1.0 passed this metric
Testing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.0 failed this metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number