sqoop-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Veena Basavaraj (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SQOOP-1680) DOC: Create an API doc for the Sqoop repository.
Date Wed, 05 Nov 2014 18:28:36 GMT

    [ https://issues.apache.org/jira/browse/SQOOP-1680?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14198788#comment-14198788

Veena Basavaraj commented on SQOOP-1680:

I have no preference where we document or what format it is, but it should exist in one place
with good details.

I can clearly highlight where we have not put in effort to document our assumptions and best
practices for the apis we have added.

>  DOC: Create an API doc for the Sqoop repository.
> -------------------------------------------------
>                 Key: SQOOP-1680
>                 URL: https://issues.apache.org/jira/browse/SQOOP-1680
>             Project: Sqoop
>          Issue Type: Bug
>            Reporter: Veena Basavaraj
>            Assignee: Veena Basavaraj
>             Fix For: 1.99.5
> Having a good doc for repository will encourage us to create better code going forward
to support other types of repository.
> Even the repo upgrade can be its own clean api
> Well we have connector developer guide that details the responsibilities. 
> I have similar thoughts for the exec engine and repository.
> You many ask why? If we think ourselves as external developers we will take less shortcuts
and make our code mode extensible and clean is my thought.
> for instance
> Should the create link api enforce the unique constraint on name or the database table
should. these are not documented anywhere clearly for someone trying to add a new repo and
the recommended practices are nice to have

This message was sent by Atlassian JIRA

View raw message