Snowflake (gradle-snowflake-plugin 2.1.22 API)

io.github.stewartbryson.Snowflake

```
@groovy.util.logging.Slf4j
class Snowflake
extends java.lang.Object
```
A class that manages connecting to Snowflake, as well as providing information about that connection. Used by core plugin tasks as well as the SnowflakeSpec specification.

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`connectionDatabase` The connection database in case it wasn't in the connection.
`java.lang.String`	`connectionRole` The connection role in case it wasn't in the connection.
`java.lang.String`	`connectionSchema` The connection schema in case it wasn't in the connection.
`java.lang.String`	`ephemeralName` The ephemeral Snowflake clone name.
`com.snowflake.snowpark_java.Session`	`session` The Snowpark session.
`SnowConfig`	`snowConfig` SnowConfig object.

Constructor Summary

Constructors
Constructor and description
`Snowflake ()` Empty constructor for use in the Gradle project.
`Snowflake (java.lang.String connection)` Constructor using auto-detected credentials config file.
`Snowflake (java.io.File config, java.lang.String connection)` Constructor using explicit credentials config file as a File object.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`getScalarValue(java.lang.String sql)` Return the first column from the first row of a SELECT statement.
	`java.lang.Boolean`	`hasSession()` Determines whether a session exists.
	`java.lang.Boolean`	`isUsingEphemeral()` Whether an ephemeral clone is in use.
	`java.lang.Object`	`setEphemeralContext()` Set ephemeral context in the Snowflake session.
	`java.lang.Object`	`setOriginalContext()` Set original connection context in the Snowflake session.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String connectionDatabase
    
    The connection database in case it wasn't in the connection.
  - java.lang.String connectionRole
    
    The connection role in case it wasn't in the connection.
  - java.lang.String connectionSchema
    
    The connection schema in case it wasn't in the connection.
  - java.lang.String ephemeralName
    
    The ephemeral Snowflake clone name.
  - com.snowflake.snowpark_java.Session session
    
    The Snowpark session.
  - SnowConfig snowConfig
    
    SnowConfig object.
- Constructor Detail
  - Snowflake()
    
    Empty constructor for use in the Gradle project.
    Returns:
    Empty Snowflake class.
  - Snowflake(java.lang.String connection)
    
    Constructor using auto-detected credentials config file.
    Returns:
    Snowflake class.
  - Snowflake(java.io.File config, java.lang.String connection)
    
    Constructor using explicit credentials config file as a File object.
    Returns:
    Snowflake class.
- Method Detail
  - java.lang.Object getScalarValue(java.lang.String sql)
    
    Return the first column from the first row of a SELECT statement.
    Returns:
    a scalar column value.
  - java.lang.Boolean hasSession()
    
    Determines whether a session exists.
    Returns:
    whether a session exists.
  - java.lang.Boolean isUsingEphemeral()
    
    Whether an ephemeral clone is in use.
    Returns:
    whether an ephemeral clone is in use.
  - java.lang.Object setEphemeralContext()
    
    Set ephemeral context in the Snowflake session.
  - java.lang.Object setOriginalContext()
    
    Set original connection context in the Snowflake session.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Snowflake

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String connectionDatabase

java.lang.String connectionRole

java.lang.String connectionSchema

java.lang.String ephemeralName

com.snowflake.snowpark_java.Session session

SnowConfig snowConfig

Constructor Detail

Snowflake()

Snowflake(java.lang.String connection)

Snowflake(java.io.File config, java.lang.String connection)

Method Detail

java.lang.Object getScalarValue(java.lang.String sql)

java.lang.Boolean hasSession()

java.lang.Boolean isUsingEphemeral()

java.lang.Object setEphemeralContext()

java.lang.Object setOriginalContext()