org.apache.flink.connector.nebula.catalog

Class NebulaCatalog

java.lang.Object

org.apache.flink.table.catalog.AbstractCatalog

org.apache.flink.connector.nebula.catalog.AbstractNebulaCatalog

org.apache.flink.connector.nebula.catalog.NebulaCatalog

All Implemented Interfaces:

org.apache.flink.table.catalog.Catalog

public class NebulaCatalog
extends AbstractNebulaCatalog

Field Summary

Fields inherited from class org.apache.flink.connector.nebula.catalog.AbstractNebulaCatalog

address, password, username

Constructor Summary

Constructors

Constructor and Description
NebulaCatalog(String catalogName, String defaultDatabase, String username, String password, String metaAddress, String graphAddress)

Method Summary

Modifier and Type	Method and Description
void	close()
void	createDatabase(String dataBaseName, org.apache.flink.table.catalog.CatalogDatabase catalogDatabase, boolean ignoreIfExists)
org.apache.flink.table.catalog.CatalogDatabase	getDatabase(String databaseName)
org.apache.flink.table.catalog.CatalogBaseTable	getTable(org.apache.flink.table.catalog.ObjectPath tablePath)
List<String>	listDatabases()
List<String>	listTables(String graphSpace) show all tags and edges
void	open()
boolean	tableExists(org.apache.flink.table.catalog.ObjectPath tablePath) objectName in tablePath mush start with VERTEX.

Methods inherited from class org.apache.flink.connector.nebula.catalog.AbstractNebulaCatalog

alterDatabase, alterFunction, alterPartition, alterPartitionColumnStatistics, alterPartitionStatistics, alterTable, alterTableColumnStatistics, alterTableStatistics, createFunction, createPartition, createTable, databaseExists, dropDatabase, dropDatabase, dropFunction, dropPartition, dropTable, functionExists, getAddress, getFactory, getFunction, getPartition, getPartitionColumnStatistics, getPartitionStatistics, getPassword, getTableColumnStatistics, getTableStatistics, getUsername, listFunctions, listPartitions, listPartitions, listPartitionsByFilter, listViews, partitionExists, renameTable

Methods inherited from class org.apache.flink.table.catalog.AbstractCatalog

getDefaultDatabase, getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.catalog.Catalog

getFunctionDefinitionFactory, getTableFactory

Constructor Detail

NebulaCatalog

public NebulaCatalog(String catalogName,
                     @Nullable
                     String defaultDatabase,
                     String username,
                     String password,
                     String metaAddress,
                     String graphAddress)

Method Detail

open

public void open()
          throws org.apache.flink.table.catalog.exceptions.CatalogException

Specified by:

open in interface org.apache.flink.table.catalog.Catalog

Overrides:

open in class AbstractNebulaCatalog

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

close

public void close()
           throws org.apache.flink.table.catalog.exceptions.CatalogException

Specified by:

close in interface org.apache.flink.table.catalog.Catalog

Overrides:

close in class AbstractNebulaCatalog

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

listDatabases

public List<String> listDatabases()
                           throws org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

getDatabase

public org.apache.flink.table.catalog.CatalogDatabase getDatabase(String databaseName)
                                                           throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException,
                                                                  org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseNotExistException

org.apache.flink.table.catalog.exceptions.CatalogException

createDatabase

public void createDatabase(String dataBaseName,
                           org.apache.flink.table.catalog.CatalogDatabase catalogDatabase,
                           boolean ignoreIfExists)
                    throws org.apache.flink.table.catalog.exceptions.CatalogException

Specified by:

createDatabase in interface org.apache.flink.table.catalog.Catalog

Overrides:

createDatabase in class AbstractNebulaCatalog

Parameters:

dataBaseName - same as graph space name in nebula graph

catalogDatabase - catalog implementation

ignoreIfExists - true if contains [if not exists] clause else false

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

tableExists

public boolean tableExists(org.apache.flink.table.catalog.ObjectPath tablePath)
                    throws org.apache.flink.table.catalog.exceptions.CatalogException

objectName in tablePath mush start with VERTEX. or EDGE.

Parameters:

tablePath - A graphSpace name and label name.

Returns:

Table exists or not

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

listTables

public List<String> listTables(String graphSpace)
                        throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException,
                               org.apache.flink.table.catalog.exceptions.CatalogException

show all tags and edges

Parameters:

graphSpace - nebula graph space

Returns:

List of Tag and Edge, tag starts with VERTEX. and edge starts with EDGE.

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseNotExistException

org.apache.flink.table.catalog.exceptions.CatalogException

getTable

public org.apache.flink.table.catalog.CatalogBaseTable getTable(org.apache.flink.table.catalog.ObjectPath tablePath)
                                                         throws org.apache.flink.table.catalog.exceptions.TableNotExistException,
                                                                org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.TableNotExistException

org.apache.flink.table.catalog.exceptions.CatalogException