Packages

class SQLConf extends Serializable with Logging

A class that enables the setting and getting of mutable config parameters/hints.

In the presence of a SQLContext, these can be set and queried by passing SET commands into Spark SQL's query functions (i.e. sql()). Otherwise, users of this class can modify the hints by programmatically calling the setters and getters of this class.

SQLConf is thread-safe (internally synchronized, so safe to be used in multiple threads).

Linear Supertypes
Logging, Serializable, Serializable, AnyRef, Any
Known Subclasses
ReadOnlySQLConf
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SQLConf
  2. Logging
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SQLConf()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def adaptiveExecutionEnabled: Boolean
  5. def adaptiveExecutionLogLevel: String
  6. def addSingleFileInAddFile: Boolean
  7. def advancedPartitionPredicatePushdownEnabled: Boolean
  8. def allowAutoGeneratedAliasForView: Boolean
  9. def allowNegativeScaleOfDecimalEnabled: Boolean
  10. def allowNonEmptyLocationInCTAS: Boolean
  11. def allowStarWithSingleTableIdentifierInCount: Boolean
  12. def analyzerMaxIterations: Int

    ************************ Spark SQL Params/Hints *******************

  13. def ansiEnabled: Boolean
  14. def arrowMaxRecordsPerBatch: Int
  15. def arrowPySparkEnabled: Boolean
  16. def arrowPySparkFallbackEnabled: Boolean
  17. def arrowPySparkSelfDestructEnabled: Boolean
  18. def arrowSafeTypeConversion: Boolean
  19. def arrowSparkREnabled: Boolean
  20. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  21. def autoBroadcastJoinThreshold: Long
  22. def autoBucketedScanEnabled: Boolean
  23. def autoSizeUpdateEnabled: Boolean
  24. def avroCompressionCodec: String
  25. def avroDeflateLevel: Int
  26. def avroFilterPushDown: Boolean
  27. def broadcastHashJoinOutputPartitioningExpandLimit: Int
  28. def broadcastTimeout: Long
  29. def bucketingEnabled: Boolean
  30. def bucketingMaxBuckets: Int
  31. def cacheVectorizedReaderEnabled: Boolean
  32. def cartesianProductExecBufferInMemoryThreshold: Int
  33. def cartesianProductExecBufferSpillThreshold: Int
  34. def caseSensitiveAnalysis: Boolean
  35. def caseSensitiveInferenceMode: SQLConf.HiveCaseSensitiveInferenceMode.Value
  36. def castDatetimeToString: Boolean
  37. def cboEnabled: Boolean
  38. def charVarcharAsString: Boolean
  39. def checkpointLocation: Option[String]
  40. def clear(): Unit
  41. def cliPrintHeader: Boolean
  42. def clone(): SQLConf
    Definition Classes
    SQLConf → AnyRef
  43. def coalesceBucketsInJoinEnabled: Boolean
  44. def coalesceBucketsInJoinMaxBucketRatio: Int
  45. def coalesceShufflePartitionsEnabled: Boolean
  46. def codegenCacheMaxEntries: Int
  47. def codegenComments: Boolean
  48. def codegenFallback: Boolean
  49. def codegenSplitAggregateFunc: Boolean
  50. def columnBatchSize: Int
  51. def columnNameOfCorruptRecord: String
  52. def concatBinaryAsString: Boolean
  53. def constraintPropagationEnabled: Boolean
  54. def contains(key: String): Boolean

    Return whether a given key is set in this SQLConf.

  55. def continuousStreamingEpochBacklogQueueSize: Int
  56. def continuousStreamingExecutorPollIntervalMs: Long
  57. def continuousStreamingExecutorQueueSize: Int
  58. def convertCTAS: Boolean
  59. def copy(entries: (ConfigEntry[_], Any)*): SQLConf
  60. def crossJoinEnabled: Boolean
  61. def csvColumnPruning: Boolean
  62. def csvExpressionOptimization: Boolean
  63. def csvFilterPushDown: Boolean
  64. def dataFramePivotMaxValues: Int
  65. def dataFrameRetainGroupColumns: Boolean
  66. def dataFrameSelfJoinAutoResolveAmbiguity: Boolean
  67. def datetimeJava8ApiEnabled: Boolean
  68. def decimalOperationsAllowPrecisionLoss: Boolean
  69. def decorrelateInnerQueryEnabled: Boolean
  70. def defaultDataSourceName: String
  71. def defaultNumShufflePartitions: Int
  72. def defaultSizeInBytes: Long
  73. def disabledJdbcConnectionProviders: String
  74. def disabledV2StreamingMicroBatchReaders: String
  75. def disabledV2StreamingWriters: String
  76. def dynamicPartitionPruningEnabled: Boolean
  77. def dynamicPartitionPruningFallbackFilterRatio: Double
  78. def dynamicPartitionPruningReuseBroadcastOnly: Boolean
  79. def dynamicPartitionPruningUseStats: Boolean
  80. def eltOutputAsString: Boolean
  81. def enableRadixSort: Boolean
  82. def enableTwoLevelAggMap: Boolean
  83. def enableVectorizedHashMap: Boolean
  84. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  86. def escapedStringLiterals: Boolean
  87. def exchangeReuseEnabled: Boolean
  88. def exponentLiteralAsDecimalEnabled: Boolean
  89. def fallBackToHdfsForStatsEnabled: Boolean
  90. def fastFailFileFormatOutput: Boolean
  91. def fastHashAggregateRowMaxCapacityBit: Int
  92. def fetchShuffleBlocksInBatch: Boolean
  93. def fileCommitProtocolClass: String
  94. def fileCompressionFactor: Double
  95. def fileSinkLogCleanupDelay: Long
  96. def fileSinkLogCompactInterval: Int
  97. def fileSinkLogDeletion: Boolean
  98. def fileSourceLogCleanupDelay: Long
  99. def fileSourceLogCompactInterval: Int
  100. def fileSourceLogDeletion: Boolean
  101. def fileStreamSinkMetadataIgnored: Boolean
  102. def filesMaxPartitionBytes: Long
  103. def filesMinPartitionNum: Option[Int]
  104. def filesOpenCostInBytes: Long
  105. def filesourcePartitionFileCacheSize: Long
  106. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  107. def gatherFastStats: Boolean
  108. def getAllConfs: Map[String, String]

    Return all the configuration properties that have been set (i.e.

    Return all the configuration properties that have been set (i.e. not the default). This creates a new copy of the config properties in the form of a Map.

  109. def getAllDefinedConfs: Seq[(String, String, String, String)]

    Return all the configuration definitions that have been defined in SQLConf.

    Return all the configuration definitions that have been defined in SQLConf. Each definition contains key, defaultValue and doc.

  110. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  111. def getConf[T](entry: OptionalConfigEntry[T]): Option[T]

    Return the value of an optional Spark SQL configuration property for the given key.

    Return the value of an optional Spark SQL configuration property for the given key. If the key is not set yet, returns None.

  112. def getConf[T](entry: ConfigEntry[T]): T

    Return the value of Spark SQL configuration property for the given key.

    Return the value of Spark SQL configuration property for the given key. If the key is not set yet, return defaultValue in ConfigEntry.

  113. def getConf[T](entry: ConfigEntry[T], defaultValue: T): T

    Return the value of Spark SQL configuration property for the given key.

    Return the value of Spark SQL configuration property for the given key. If the key is not set yet, return defaultValue. This is useful when defaultValue in ConfigEntry is not the desired one.

  114. def getConfString(key: String, defaultValue: String): String

    Return the string value of Spark SQL configuration property for the given key.

    Return the string value of Spark SQL configuration property for the given key. If the key is not set yet, return defaultValue.

  115. def getConfString(key: String): String

    Return the value of Spark SQL configuration property for the given key.

    Return the value of Spark SQL configuration property for the given key.

    Annotations
    @throws( "if key is not set" )
  116. def groupByAliases: Boolean
  117. def groupByOrdinal: Boolean
  118. def groupingIdWithAppendedUserGroupByEnabled: Boolean
  119. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  120. def hintErrorHandler: HintErrorHandler

    Returns the error handler for handling hint errors.

  121. def histogramEnabled: Boolean
  122. def histogramNumBins: Int
  123. def hiveThriftServerSingleSession: Boolean
  124. def hugeMethodLimit: Int
  125. def ignoreCorruptFiles: Boolean
  126. def ignoreDataLocality: Boolean
  127. def ignoreMissingFiles: Boolean
  128. def inMemoryPartitionPruning: Boolean
  129. def inMemoryTableScanStatisticsEnabled: Boolean
  130. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  131. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  132. def integerGroupingIdEnabled: Boolean
  133. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  134. def isModifiable(key: String): Boolean
  135. def isOrcSchemaMergingEnabled: Boolean
  136. def isParquetBinaryAsString: Boolean
  137. def isParquetINT96AsTimestamp: Boolean
  138. def isParquetINT96TimestampConversion: Boolean
  139. def isParquetSchemaMergingEnabled: Boolean
  140. def isParquetSchemaRespectSummaries: Boolean
  141. def isReplEagerEvalEnabled: Boolean
  142. def isStateSchemaCheckEnabled: Boolean
  143. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  144. def isUnsupportedOperationCheckEnabled: Boolean
  145. def joinReorderCardWeight: Double
  146. def joinReorderDPStarFilter: Boolean
  147. def joinReorderDPThreshold: Int
  148. def joinReorderEnabled: Boolean
  149. def jsonExpressionOptimization: Boolean
  150. def jsonFilterPushDown: Boolean
  151. def jsonGeneratorIgnoreNullFields: Boolean
  152. def legacyIntervalEnabled: Boolean
  153. def legacyMsSqlServerNumericMappingEnabled: Boolean
  154. def legacyParquetNanosAsLong: Boolean
  155. def legacyPathOptionBehavior: Boolean
  156. def legacySizeOfNull: Boolean
  157. def legacyStatisticalAggregate: Boolean
  158. def legacyTimeParserPolicy: SQLConf.LegacyBehaviorPolicy.Value
  159. def limitScaleUpFactor: Int
  160. def literalPickMinimumPrecision: Boolean
  161. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  162. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  163. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  164. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  165. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  166. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  167. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  168. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  169. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  170. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  171. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  172. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  173. def loggingMaxLinesForCodegen: Int
  174. def manageFilesourcePartitions: Boolean
  175. def maxBatchesToRetainInMemory: Int
  176. def maxConcurrentOutputFileWriters: Int
  177. def maxMetadataStringLength: Int
  178. def maxNestedViewDepth: Int
  179. def maxPlanStringLength: Int
  180. def maxRecordsPerFile: Long
  181. def maxToStringFields: Int
  182. def metadataCacheTTL: Long
  183. def metastorePartitionPruning: Boolean
  184. def metastorePartitionPruningInSetThreshold: Int
  185. def methodSplitThreshold: Int
  186. def minBatchesToRetain: Int
  187. def nameNonStructGroupingKeyAsValue: Boolean
  188. def ndvMaxError: Double
  189. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  190. def nestedPruningOnExpressions: Boolean
  191. def nestedSchemaPruningEnabled: Boolean
  192. def nonEmptyPartitionRatioForBroadcastJoin: Double
  193. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  194. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  195. def numShufflePartitions: Int
  196. def objectAggSortBasedFallbackThreshold: Int
  197. def offHeapColumnVectorEnabled: Boolean
  198. def optimizeNullAwareAntiJoin: Boolean
  199. def optimizerExcludedRules: Option[String]
  200. def optimizerInSetConversionThreshold: Int
  201. def optimizerInSetSwitchThreshold: Int
  202. def optimizerMaxIterations: Int
  203. def optimizerMetadataOnly: Boolean
  204. def orcCompressionCodec: String
  205. def orcFilterPushDown: Boolean
  206. def orcVectorizedReaderBatchSize: Int
  207. def orcVectorizedReaderEnabled: Boolean
  208. def orcVectorizedReaderNestedColumnEnabled: Boolean
  209. def orderByOrdinal: Boolean
  210. def pandasGroupedMapAssignColumnsByName: Boolean
  211. def pandasUDFBufferSize: Int
  212. def parallelFileListingInStatsComputation: Boolean
  213. def parallelPartitionDiscoveryParallelism: Int
  214. def parallelPartitionDiscoveryThreshold: Int
  215. def parquetCompressionCodec: String
  216. def parquetFilterPushDown: Boolean
  217. def parquetFilterPushDownDate: Boolean
  218. def parquetFilterPushDownDecimal: Boolean
  219. def parquetFilterPushDownInFilterThreshold: Int
  220. def parquetFilterPushDownStringStartWith: Boolean
  221. def parquetFilterPushDownTimestamp: Boolean
  222. def parquetOutputCommitterClass: String
  223. def parquetOutputTimestampType: SQLConf.ParquetOutputTimestampType.Value
  224. def parquetRecordFilterEnabled: Boolean
  225. def parquetVectorizedReaderBatchSize: Int
  226. def parquetVectorizedReaderEnabled: Boolean
  227. def partitionColumnTypeInferenceEnabled: Boolean
  228. def partitionOverwriteMode: SQLConf.PartitionOverwriteMode.Value
  229. def percentileAccuracy: Int
  230. def planChangeBatches: Option[String]
  231. def planChangeLogLevel: String
  232. def planChangeRules: Option[String]
  233. def planStatsEnabled: Boolean
  234. def preferSortMergeJoin: Boolean
  235. def pysparkJVMStacktraceEnabled: Boolean
  236. def pysparkSimplifiedTraceback: Boolean
  237. def rangeExchangeSampleSizePerPartition: Int
  238. val reader: ConfigReader
    Attributes
    protected
  239. def redactOptions[K, V](options: Seq[(K, V)]): Seq[(K, V)]

    Redacts the given option map according to the description of SQL_OPTIONS_REDACTION_PATTERN.

  240. def redactOptions[K, V](options: Map[K, V]): Map[K, V]

    Redacts the given option map according to the description of SQL_OPTIONS_REDACTION_PATTERN.

  241. def replEagerEvalMaxNumRows: Int
  242. def replEagerEvalTruncate: Int
  243. def replaceDatabricksSparkAvroEnabled: Boolean
  244. def replaceExceptWithFilter: Boolean
  245. def resolver: Resolver

    Returns the Resolver for the current configuration, which can be used to determine if two identifiers are equal.

  246. def runSQLonFile: Boolean
  247. def serializerNestedSchemaPruningEnabled: Boolean
  248. def sessionLocalTimeZone: String
  249. def sessionWindowBufferInMemoryThreshold: Int
  250. def sessionWindowBufferSpillThreshold: Int
  251. def setCommandRejectsSparkCoreConfs: Boolean
  252. def setConf[T](entry: ConfigEntry[T], value: T): Unit

    Set the given Spark SQL configuration property.

  253. def setConf(props: Properties): Unit

    Set Spark SQL configuration properties.

  254. def setConfString(key: String, value: String): Unit

    Set the given Spark SQL configuration property using a string value.

  255. def setConfWithCheck(key: String, value: String): Unit
    Attributes
    protected
  256. def setOpsPrecedenceEnforced: Boolean
  257. val settings: Map[String, String]

    Only low degree of contention is expected for conf, thus NOT using ConcurrentHashMap.

    Only low degree of contention is expected for conf, thus NOT using ConcurrentHashMap.

    Attributes
    protected[spark]
  258. def sortBeforeRepartition: Boolean
  259. def sortMergeJoinExecBufferInMemoryThreshold: Int
  260. def sortMergeJoinExecBufferSpillThreshold: Int
  261. def starSchemaDetection: Boolean
  262. def starSchemaFTRatio: Double
  263. def stateStoreCompressionCodec: String
  264. def stateStoreFormatValidationEnabled: Boolean
  265. def stateStoreMinDeltasForSnapshot: Int
  266. def stateStoreProviderClass: String
  267. def stateStoreSkipNullsForStreamStreamJoins: Boolean
  268. def statefulOperatorCorrectnessCheckEnabled: Boolean
  269. def storeAnalyzedPlanForView: Boolean
  270. def storeAssignmentPolicy: SQLConf.StoreAssignmentPolicy.Value
  271. def streamingFileCommitProtocolClass: String
  272. def streamingMaintenanceInterval: Long
  273. def streamingMetricsEnabled: Boolean
  274. def streamingNoDataMicroBatchesEnabled: Boolean
  275. def streamingNoDataProgressEventInterval: Long
  276. def streamingPollingDelay: Long
  277. def streamingProgressRetention: Int
  278. def streamingSchemaInference: Boolean
  279. def streamingSessionWindowMergeSessionInLocalPartition: Boolean
  280. def stringRedactionPattern: Option[Regex]
  281. def subexpressionEliminationCacheMaxEntries: Int
  282. def subexpressionEliminationEnabled: Boolean
  283. def subqueryReuseEnabled: Boolean
  284. def supportQuotedRegexColumnName: Boolean
  285. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  286. def tableRelationCacheSize: Int
  287. def timestampType: AtomicType
  288. def toString(): String
    Definition Classes
    AnyRef → Any
  289. def topKSortFallbackThreshold: Int
  290. def truncateTableIgnorePermissionAcl: Boolean
  291. def uiExplainMode: String
  292. def unsetConf(entry: ConfigEntry[_]): Unit
  293. def unsetConf(key: String): Unit
  294. def useCompression: Boolean
  295. def useCurrentSQLConfigsForView: Boolean
  296. def useDeprecatedKafkaOffsetFetching: Boolean
  297. def useObjectHashAggregation: Boolean
  298. def validatePartitionColumns: Boolean
  299. def variableSubstituteEnabled: Boolean
  300. def verifyPartitionPath: Boolean
  301. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  302. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  303. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  304. def warehousePath: String
  305. def wholeStageEnabled: Boolean
  306. def wholeStageMaxNumFields: Int
  307. def wholeStageSplitConsumeFuncByOperator: Boolean
  308. def wholeStageUseIdInClassName: Boolean
  309. def windowExecBufferInMemoryThreshold: Int
  310. def windowExecBufferSpillThreshold: Int
  311. def writeLegacyParquetFormat: Boolean

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped