Installation Guide

Data Retriever using Julia

The wrapper module for Data Retriever has been implemented as Retriever. All the functions work and feel the same as the python Retriever module. The module has been created using $PyCall$ hence all the functions are analogous to the functions of Retriever python module.

Installation

To use Retriever, you first need to install Retriever, a core python package.

To install Retriever using the Julia package manager


    julia> Pkg.add("Retriever")

To install from Source, download or checkout the source from the github page.

Go to Retriever.jl/src. Run Julia.


    julia> include("Retriever.jl")

(Note: If you want help in installing Julia you can follow this tutorial

Tutorial

Get list of all the available datasets in Retriever.


    """ Function Definition """
    function dataset_names()
    
    julia> Retriever.dataset_names()

Updating scripts to the latest version.


    """ Function Definition """
    function check_for_updates()

    julia> Retriever.check_for_updates()

Delete information stored by Retriever which could be scripts, connections or data.


    """ Function Definition """
    function reset_retriever(; scope::AbstractString="all")

    """ Using default variable all"""
    julia> Retriever.reset_retriever()
    """ Set scope as scripts """
    julia> Retriever.reset_retriever(scope="scripts")

To download datasets the $download$ function can be used.


    """ Function Definition """
    function download(dataset; path::AbstractString="./", quite::Bool=false,
                subdir::Bool=false, use_cache::Bool=false, debug::Bool=false)

    
    julia> Retriever.download("iris")

Installing scripts into engines.


    """ Function Definition """
    function install_csv(dataset; table_name=nothing, compile::Bool=false,
                debug::Bool=false, quite::Bool=false, use_cache::Bool=true)

    function install_mysql(dataset; user::AbstractString="root",
                password::AbstractString="", host::AbstractString="localhost",
                port::Int=3306, database_name=nothing, table_name=nothing,
                compile::Bool=false, debug::Bool=false, quite::Bool=false,
                use_cache::Bool=true)

    function install_postgres(dataset; user::AbstractString="postgres",
                password::AbstractString="", host::AbstractString="localhost",
                port::Int=5432, database::AbstractString="postgres",
                database_name=nothing, table_name=nothing, compile::Bool=false,
                debug::Bool=false, quite::Bool=false, use_cache::Bool=true)

    function install_sqlite(dataset; file=nothing, table_name=nothing,
                compile::Bool=false, debug::Bool=false, quite::Bool=false,
                use_cache::Bool=true)

    function install_msaccess(dataset; file=nothing, table_name=nothing,
                compile::Bool=false, debug::Bool=false, quite::Bool=false,
                use_cache::Bool=true)

    function install_json(dataset; table_name=nothing, compile::Bool=false,
                debug::Bool=false, quite::Bool=false, use_cache::Bool=true)

    function install_xml(dataset; table_name=nothing, compile::Bool=false,
                debug::Bool=false, quite::Bool=false, use_cache::Bool=true)
    
    julia> Retriever.install_csv("iris")
    julia> Retriever.install_mysql("iris")
    julia> Retriever.install_postgres("iris")
    julia> Retriever.install_sqlite("iris")
    julia> Retriever.install_msaccess("iris")
    julia> Retriever.install_json("iris")
    julia> Retriever.install_xml("iris")