Skip to main content

Easy access to the DES DB. Enhanced command line SQL interpreter client for DES

Project description

# easyaccess <a href=""> <img src="" alt="latest release" /></a> <a href=""><img src="" alt="License" /> </a> <a href=""><img src="" alt="pypi version"/></a>

Enhanced command line SQL interpreter client for astronomical databases.

Python Command Line Interpreter to access Oracle DES DB
using cx_Oracle

For a short tutorial (To be completed) check [here](
(Using des credentials)

**Current version = 1.3.1**

## Requirements

- Oracle Client > 11g.2 (External library, no python)
Check [here]( for instructions on how to install these libraries
- [cx_Oracle](
- [fitsio]( >= 0.9.6
- [pandas]( >= 0.14
- [termcolor](
- [PyTables]( (optional, for hdf5 output)
- [future]( (for python 2/3 compatibility)
- [requests](
- **Note that you need to install python-future for python2/3 compatibility**

## Some *nice* features
- Nice output format (using pandas)
- Very flexible configuration
- Smart tab completion for commands, table names, column names and file paths accordingly
- write output results to csv, tab, fits files or HDF5 files
- load tables from csv, fits or hdf5 directly into DB (memory friendly by using number of rows or memory limit)
- intrinsic db commands to describe tables, own schema, quota and more
- It can be imported as module from python, extense python API
- Can run command directly from command line
- Load sql query from file and/or from editor
- Show the execution plan of a query if required
- Can run python functions inline query
- Many more

## Conda installation
Now easyaccess can be installed using [conda]( out of the box!

conda install easyaccess -c mgckind

## Interactive interpreter

Assuming that ```easyaccess``` is in your path, you can enter the interactive interpreter by calling ```easyaccess``` without any command line arguments:


### Running SQL commands
Once inside the interpreter run SQL queries by adding a ";" at the end::

DESDB ~> select ... from ... where ... ;

To save the results into a table add ">" after the end of the query (after ";") and namefile at the end of line

DESDB ~> select ... from ... where ... ; > test.fits

The file types supported so far are: .csv, .tab, .fits, and .h5. Any other extension is ignored.

### Load tables
To load a table it needs to be in a csv format with columns names in the first row
the name of the table is taken from filename or with optional argument --tablename

DESDB ~> load_table <filename> --tablename <mytable> --chunksize <number of rows to read/upload> --memsize <memory in MB to read at a time>

The --chunsize and --memsize are optional arguments to facilitate uploading big files.

### Load SQL queries
To load SQL queries just run:

DESDB ~> loadsql <filename.sql>

DESDB ~> @filename.sql

The query format is the same as the interpreter, SQL statement must end with ";" and to write output files the query must be followed by " > <output file>"

### Configuration

The configuration file is located at ```$HOME/.easyaccess/config.ini``` but everything can be configured from inside easyaccess type:

DESDB ~> help config

to see the meanings of all the options, and:

DESDB ~> config all show

to see the current values, to modify one value, e.g., the prefetch value

DESDB ~> config prefetch set 50000

and to see any particular option (e.g., timeout):

DESDB ~> config timeout show

## Command-line usage

Much of the functionality provided through the interpreter is also available directly from the command line. To see a list of command-line options, use the ```--help``` option

easyaccess --help

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for easyaccess, version 1.4.0a1
Filename, size File type Python version Upload date Hashes
Filename, size easyaccess-1.4.0a1-py2.py3-none-any.whl (53.1 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size easyaccess-1.4.0a1.tar.gz (165.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page