Package dev.frostlake.metastore.model

Class Stage

java.lang.Object

dev.frostlake.metastore.SqlObject

dev.frostlake.metastore.model.Stage

All Implemented Interfaces:

Taggable

public class Stage
extends SqlObject

Represents a Snowflake STAGE - a named location for staging data files. Supports local filesystem staging for data loading and unloading operations. S3 stages are simulated using local filesystem paths.

Field Summary

Fields inherited from class dev.frostlake.metastore.SqlObject

comment, createdTime, name, owner

Constructor Summary

Constructors

Constructor	Description
Stage(String name, StageType type, String url)
Stage(String name, StageType type, String url, String fileFormat, boolean encryption, String comment)
Stage(String name, StageType type, String url, String fileFormat, boolean encryption, String comment, S3PathResolver s3Resolver)

Method Summary

Modifier and Type	Method	Description
boolean	fileExists(String fileName)	Check if a file exists in the stage
Map<String,String>	getCopyOptions()
Instant	getCreatedAt()
String	getEncryptionType()	The declared ENCRYPTION TYPE (e.g.
void	getFile(String fileName, Path destPath)	Get a file from the stage
String	getFileFormat()
Map<String,String>	getFileFormatOptions()
Path	getFilePath(String fileName)	Get full path to a file in the stage
Path	getLocalPath()
String	getObjectType()	Get the type of this SQL object (e.g., "TABLE", "VIEW", "DATABASE") Subclasses should override to provide their specific type
String	getS3Bucket()	Get the S3 bucket name (if this is an S3 stage)
String	getS3Prefix()	Get the S3 prefix/path (if this is an S3 stage)
StageType	getType()
String	getUrl()
boolean	isDirectoryEnabled()
boolean	isEncryption()
boolean	isS3Simulated()	Check if this stage is using S3 simulation
List<StageFile>	listFiles()	List files in the stage
List<StageFile>	listFiles(String pattern)	List files in the stage with optional pattern
void	putFile(Path sourceFile)	Put a file into the stage
boolean	removeFile(String fileName)	Remove a file from the stage
void	setDirectoryEnabled(boolean directoryEnabled)
void	setEncryptionType(String encryptionType)
void	setFileFormat(String fileFormat)	ALTER STAGE … SET FILE_FORMAT.
void	setUrl(String url)	ALTER STAGE … SET URL — repoint the stage and recompute its local directory.
String	toString()

Methods inherited from class dev.frostlake.metastore.SqlObject

equals, getComment, getCreatedTime, getName, getOwner, getTagValue, getTagValues, hashCode, rename, setComment, setName, setOwner, setTag, unsetTag, withoutTrailingSemicolon

Methods inherited from class java.lang.Object

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

Constructor Details

Stage

public Stage(String name,
 StageType type,
 String url)

Stage

public Stage(String name,
 StageType type,
 String url,
 String fileFormat,
 boolean encryption,
 String comment)

Stage

public Stage(String name,
 StageType type,
 String url,
 String fileFormat,
 boolean encryption,
 String comment,
 S3PathResolver s3Resolver)

Method Details

getFileFormatOptions

public Map<String,String> getFileFormatOptions()

getCopyOptions

public Map<String,String> getCopyOptions()

isDirectoryEnabled

public boolean isDirectoryEnabled()

setDirectoryEnabled

public void setDirectoryEnabled(boolean directoryEnabled)

setUrl

public void setUrl(String url)

ALTER STAGE … SET URL — repoint the stage and recompute its local directory.

setFileFormat

public void setFileFormat(String fileFormat)

ALTER STAGE … SET FILE_FORMAT.

getType

public StageType getType()

getUrl

public String getUrl()

getFileFormat

public String getFileFormat()

isEncryption

public boolean isEncryption()

getEncryptionType

public String getEncryptionType()

The declared ENCRYPTION TYPE (e.g. SNOWFLAKE_SSE), or null for the account default.

setEncryptionType

public void setEncryptionType(String encryptionType)

getCreatedAt

public Instant getCreatedAt()

getLocalPath

public Path getLocalPath()

getObjectType

public String getObjectType()

Description copied from class: SqlObject

Get the type of this SQL object (e.g., "TABLE", "VIEW", "DATABASE") Subclasses should override to provide their specific type

Specified by:

getObjectType in class SqlObject

Returns:

The object type as a string

listFiles

public List<StageFile> listFiles()
                          throws IOException

List files in the stage

Throws:

IOException

listFiles

public List<StageFile> listFiles(String pattern)
                          throws IOException

List files in the stage with optional pattern

Throws:

IOException

fileExists

public boolean fileExists(String fileName)

Check if a file exists in the stage

getFilePath

public Path getFilePath(String fileName)

Get full path to a file in the stage

putFile

public void putFile(Path sourceFile)
             throws IOException

Put a file into the stage

Throws:

IOException

getFile

public void getFile(String fileName,
 Path destPath)
             throws IOException

Get a file from the stage

Throws:

IOException

removeFile

public boolean removeFile(String fileName)
                   throws IOException

Remove a file from the stage

Throws:

IOException

isS3Simulated

public boolean isS3Simulated()

Check if this stage is using S3 simulation

getS3Bucket

public String getS3Bucket()

Get the S3 bucket name (if this is an S3 stage)

getS3Prefix

public String getS3Prefix()

Get the S3 prefix/path (if this is an S3 stage)

toString

public String toString()

Overrides:

toString in class SqlObject