[jira] [Updated] (CARBONDATA-1871) Add annotation for interface compatibility

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Updated] (CARBONDATA-1871) Add annotation for interface compatibility

Akash R Nilugal (Jira)

     [ https://issues.apache.org/jira/browse/CARBONDATA-1871?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jacky Li updated CARBONDATA-1871:
---------------------------------
    Description:
All use facing API should be annotated with proper stability level.
InterfaceStability level includes:
1. Forever: API in this level is compatible across major version
2. Stable: API in this level is compatible across minor version, maybe break across major version
3. Evolving: API in this level is compatible across maintenance version, maybe break across minor version
4. Unstable: API in this level is not backward compatible guranteed

Since user mainly use SQL for carbondata, the API need to be annotated includes:
1. Table Property in create table
2. Load Option in load data and dataframe api
3. Carbon Property

  was:
All use facing API should be annotated with proper stability level.
InterfaceStability level includes:
1. Forever: API in this level is compatible across major version
2. Stable: API in this level is compatible across minor version, maybe break across major version
3. Evolving: API in this level is compatible across maintenance version, maybe break across minor version
4. Unstable: API in this level is not backward compatible guranteed


> Add annotation for interface compatibility
> ------------------------------------------
>
>                 Key: CARBONDATA-1871
>                 URL: https://issues.apache.org/jira/browse/CARBONDATA-1871
>             Project: CarbonData
>          Issue Type: Improvement
>            Reporter: Jacky Li
>             Fix For: 1.3.0
>
>
> All use facing API should be annotated with proper stability level.
> InterfaceStability level includes:
> 1. Forever: API in this level is compatible across major version
> 2. Stable: API in this level is compatible across minor version, maybe break across major version
> 3. Evolving: API in this level is compatible across maintenance version, maybe break across minor version
> 4. Unstable: API in this level is not backward compatible guranteed
> Since user mainly use SQL for carbondata, the API need to be annotated includes:
> 1. Table Property in create table
> 2. Load Option in load data and dataframe api
> 3. Carbon Property



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)