org.apache.carbondata.sdk.file

Class CarbonSchemaReader

java.lang.Object

org.apache.carbondata.sdk.file.CarbonSchemaReader

public class CarbonSchemaReader
extends Object

Schema reader for carbon files, including carbondata file, carbonindex file, and schema file

Constructor Summary

Constructors

Constructor and Description
CarbonSchemaReader()

Method Summary

Modifier and Type	Method and Description
static String	getVersionDetails(String dataFilePath) This method return the version details in formatted string by reading from carbondata file
static Schema	readSchema(String path) read schema from path, path can be folder path, carbonindex file path, and carbondata file path and will not check all files schema
static Schema	readSchema(String path, boolean validateSchema) read schema from path, path can be folder path, carbonindex file path, and carbondata file path and user can decide whether check all files schema
static Schema	readSchemaFromDataFile(String dataFilePath) Read schema from carbondata file
static Schema	readSchemaInDataFile(String dataFilePath) Deprecated.
static Schema	readSchemaInIndexFile(String indexFilePath) Deprecated.
static Schema	readSchemaInSchemaFile(String schemaFilePath) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CarbonSchemaReader

public CarbonSchemaReader()

Method Detail

readSchemaInSchemaFile

@Deprecated
public static Schema readSchemaInSchemaFile(String schemaFilePath)
                                                 throws IOException

Deprecated.

Read schema file and return the schema

Parameters:

schemaFilePath - complete path including schema file name

Returns:

schema object

Throws:

IOException

readSchema

public static Schema readSchema(String path)
                         throws IOException

read schema from path, path can be folder path, carbonindex file path, and carbondata file path and will not check all files schema

Parameters:

path - file/folder path

Returns:

schema

Throws:

IOException

readSchema

public static Schema readSchema(String path,
                                boolean validateSchema)
                         throws IOException

read schema from path, path can be folder path, carbonindex file path, and carbondata file path and user can decide whether check all files schema

Parameters:

path - file/folder path

validateSchema - whether check all files schema

Returns:

schema

Throws:

IOException

readSchemaInDataFile

@Deprecated
public static Schema readSchemaInDataFile(String dataFilePath)
                                               throws IOException

Deprecated.

Read carbondata file and return the schema This interface will be removed, please use readSchema instead of this interface

Parameters:

dataFilePath - carbondata file store path

Returns:

Schema object

Throws:

IOException

readSchemaFromDataFile

public static Schema readSchemaFromDataFile(String dataFilePath)
                                     throws IOException

Read schema from carbondata file

Parameters:

dataFilePath - carbondata file path

Returns:

carbon data schema

Throws:

IOException

readSchemaInIndexFile

@Deprecated
public static Schema readSchemaInIndexFile(String indexFilePath)
                                                throws IOException

Deprecated.

Read carbonindex file and return the schema This interface will be removed, please use readSchema instead of this interface

Parameters:

indexFilePath - complete path including index file name

Returns:

schema object

Throws:

IOException

getVersionDetails

public static String getVersionDetails(String dataFilePath)
                                throws IOException

This method return the version details in formatted string by reading from carbondata file

Parameters:

dataFilePath -

Returns:

Throws:

IOException