Package com.mongodb.spark.sql.connector

Class MongoTable

java.lang.Object

com.mongodb.spark.sql.connector.MongoTable

All Implemented Interfaces:

SupportsRead, SupportsWrite, Table

public class MongoTable
extends java.lang.Object
implements Table, SupportsWrite, SupportsRead

Represents a MongoDB Collection.

Constructor Summary

Constructors

Constructor	Description
MongoTable(MongoConfig mongoConfig)	Construct a new instance
MongoTable(StructType schema, MongoConfig mongoConfig)	Construct a new instance
MongoTable(StructType schema, Transform[] partitioning, MongoConfig mongoConfig)	Construct a new instance

Method Summary

Modifier and Type	Method	Description
java.util.Set<TableCapability>	capabilities()	Returns the set of capabilities for this table.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	name()	The name of this table.
ScanBuilder	newScanBuilder(CaseInsensitiveStringMap options)	Returns a MongoScanBuilder.
WriteBuilder	newWriteBuilder(LogicalWriteInfo info)	Returns a MongoWriteBuilder.
Transform[]	partitioning()
java.util.Map<java.lang.String,java.lang.String>	properties()
StructType	schema()	Returns the schema of this table.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MongoTable

public MongoTable(MongoConfig mongoConfig)

Construct a new instance

Parameters:

mongoConfig - The specified table configuration

MongoTable

public MongoTable(StructType schema,
                  MongoConfig mongoConfig)

Construct a new instance

Parameters:

schema - The specified table schema.

mongoConfig - The specified table configuration

MongoTable

public MongoTable(StructType schema,
                  Transform[] partitioning,
                  MongoConfig mongoConfig)

Construct a new instance

Parameters:

schema - The specified table schema.

partitioning - The specified table partitioning.

mongoConfig - The specified table configuration

Method Detail

name

public java.lang.String name()

The name of this table.

Specified by:

name in interface Table

newWriteBuilder

public WriteBuilder newWriteBuilder(LogicalWriteInfo info)

Returns a MongoWriteBuilder.

Specified by:

newWriteBuilder in interface SupportsWrite

Parameters:

info - the logical write info

newScanBuilder

public ScanBuilder newScanBuilder(CaseInsensitiveStringMap options)

Returns a MongoScanBuilder.

Specified by:

newScanBuilder in interface SupportsRead

Parameters:

options - the CaseInsensitiveStringMap with configuration regarding the read

schema

public StructType schema()

Returns the schema of this table.

Specified by:

schema in interface Table

partitioning

public Transform[] partitioning()

Specified by:

partitioning in interface Table

properties

public java.util.Map<java.lang.String,java.lang.String> properties()

Specified by:

properties in interface Table

capabilities

public java.util.Set<TableCapability> capabilities()

Returns the set of capabilities for this table.

Specified by:

capabilities in interface Table

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object