Git Product home page Git Product logo

module-build-chado's Introduction

NAME

Module::Build::Chado - Build,configure and test chado database backed modules and applications

VERSION

version 0.0011

SYNOPSIS

In Build.PL:

use Module::Build::Chado;

my $build = Module::Build::Chado->new( module_name => 'MyChadoApp', license => 'perl', dist_abstract => 'My chado module' dist_version => '1.0'

);

$build->create_build_script;

On the command line:

perl Build.PL (default is a temporary SQLite database)

./Build test (deploy chado schema and load fixtures)

./Build test --dsn "dbi:Pg:dbname=mychado" --user tucker --password booze

./Build test --dsn "dbi:Oracle:sid=myoracle" --user tucker --password hammer

./Build deploy_schema (deploy a chado schema)

./Build load_fixture (load some standard fixtures)

./Build drop_schema

DESCRIPTION

This is subclass of Module::Build to configure, build and test chado database backed perl modules and applications. It is based on Bio::Chado::Schema and provides the following additional features ...

  • Extra Module::Build properties and actions to deploy, load fixtures and run tests on a chado database schema.

  • Support SQLite, Postgresql and Oracle backends.

ATTRIBUTES

dsn

Database connect string, defaults to a temporary SQLite database.

user

Database user, not needed for SQLite backend.

password

Database password, not needed for SQLite backend.

superuser

Database super user, in case the regular use do not have enough permissions for manipulating the database schema. It defaults to the user attribute.

superpassword

Similar concept as superuser

ddl

DDL file for particular backend, by default comes for SQLite, Postgresql and Oracle.

organism_fixuture

Fixture for loading organisms, by default the distribution comes with a organism.yaml file.

rel_fixuture

Relation ontology file in obo_xml format. The distribution includes a relationship.obo_xml file.

so_fixuture

Sequence ontology file in obo_xml format. By default, it includes sofa.obo_xml file.

METHODS

connect_hash

Returns a hash with the following connection specific keys ...

dsn
user
password
dbi_attributes

connect_info

Returns an 4 elements array with connection arguments identical to DBI's connect method.

Actions

setup

Sets up the basic parameters for the build object and loads the specific backend class. It is called by every other action. Override of calling it separately absolutely not recommended.

create

Creates a database. However, at this point it is not implemented for Postgresql and Oracle backends. For that, you need to use database specific client tools. For SQLite backend the database is created when the schema is loaded.

deploy

Deploy a chado database to the specified backend. Create action is implied.

deploy_schema

Deploy a chado database to the specified backend. Unlike the deploy action, create action is not implied here. So, except SQLite backend, this action expects a database to be created already.

load_organism

Loads the organism fixture to the deployed chado schema. deploy_schema action is implied.

load_rel

Load the relationship ontology. deploy_schema action is implied.

load_so

Load the sequence ontology. load_rel action is implied.

load_fixture

Load all fixtures in the given order.

organism
relationship ontology
sequence ontology

deploy_schema is implied.

unload_rel

Deletes the relationship ontology.

unload_so

Deletes the sequence ontology.

unload_organism

Deletes the organisms.

unload_fixture

Delete all fixtures including organism, relationship and sequence ontologies.

prune_fixture

Delete all fixtures. However, unlike running all the dependent unload_actions similar to unload_fixture it empties all the database tables. It runs a little bit faster than unload_fixture.

test

Overrides the default Action_test of Module::Build. This action drop any existing schema, loads the fixture along with the schema, runs all the tests and then drops the schema.

drop

Drops the database. However, except SQLite it is not implemented for Oracle and Postgresql.

drop_schema

Drops the database schema.

AUTHOR

Siddhartha Basu <[email protected]>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Siddhartha Basu.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

module-build-chado's People

Contributors

cybersiddhu avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.