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, AnyRef, Any
Known Subclasses
ReadOnlySQLConf
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SQLConf
  2. Logging
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 allowsTempViewCreationWithMultipleNameparts: Boolean
  13. def analyzerMaxIterations: Int

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

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

    Return whether a given key is set in this SQLConf.

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

  120. 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.

  121. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  122. 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.

  123. 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.

  124. 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.

  125. 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.

  126. 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")
  127. def groupByAliases: Boolean
  128. def groupByOrdinal: Boolean
  129. def groupingIdWithAppendedUserGroupByEnabled: Boolean
  130. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  131. def hintErrorHandler: HintErrorHandler

    Returns the error handler for handling hint errors.

  132. def histogramEnabled: Boolean
  133. def histogramNumBins: Int
  134. def histogramNumericPropagateInputType: Boolean
  135. def hiveThriftServerSingleSession: Boolean
  136. def hugeMethodLimit: Int
  137. def ignoreCorruptFiles: Boolean
  138. def ignoreDataLocality: Boolean
  139. def ignoreMissingFiles: Boolean
  140. def ignoreMissingParquetFieldId: Boolean
  141. def inMemoryPartitionPruning: Boolean
  142. def inMemoryTableScanStatisticsEnabled: Boolean
  143. def inferDictAsStruct: Boolean
  144. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  145. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  146. def integerGroupingIdEnabled: Boolean
  147. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  148. def isModifiable(key: String): Boolean
  149. def isOrcSchemaMergingEnabled: Boolean
  150. def isParquetBinaryAsString: Boolean
  151. def isParquetINT96AsTimestamp: Boolean
  152. def isParquetINT96TimestampConversion: Boolean
  153. def isParquetSchemaMergingEnabled: Boolean
  154. def isParquetSchemaRespectSummaries: Boolean
  155. def isReplEagerEvalEnabled: Boolean
  156. def isStateSchemaCheckEnabled: Boolean
  157. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  158. def isUnsupportedOperationCheckEnabled: Boolean
  159. def joinReorderCardWeight: Double
  160. def joinReorderDPStarFilter: Boolean
  161. def joinReorderDPThreshold: Int
  162. def joinReorderEnabled: Boolean
  163. def jsonEnableDateTimeParsingFallback: Option[Boolean]
  164. def jsonEnablePartialResults: Boolean
  165. def jsonExpressionOptimization: Boolean
  166. def jsonFilterPushDown: Boolean
  167. def jsonGeneratorIgnoreNullFields: Boolean
  168. def jsonWriteNullIfWithDefaultValue: Boolean
  169. def legacyInferArrayTypeFromFirstElement: Boolean
  170. def legacyIntervalEnabled: Boolean
  171. def legacyMsSqlServerNumericMappingEnabled: Boolean
  172. def legacyParquetNanosAsLong: Boolean
  173. def legacyPathOptionBehavior: Boolean
  174. def legacySizeOfNull: Boolean
  175. def legacyStatisticalAggregate: Boolean
  176. def legacyTimeParserPolicy: SQLConf.LegacyBehaviorPolicy.Value
  177. def limitInitialNumPartitions: Int
  178. def limitScaleUpFactor: Int
  179. def literalPickMinimumPrecision: Boolean
  180. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  181. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  182. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  183. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  184. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  185. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  186. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  187. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  188. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  189. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  190. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  191. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  192. def loggingMaxLinesForCodegen: Int
  193. def manageFilesourcePartitions: Boolean
  194. def maxBatchesToRetainInMemory: Int
  195. def maxConcurrentOutputFileWriters: Int
  196. def maxMetadataStringLength: Int
  197. def maxNestedViewDepth: Int
  198. def maxPlanStringLength: Int
  199. def maxRecordsPerFile: Long
  200. def maxToStringFields: Int
  201. def metadataCacheTTL: Long
  202. def metastoreDropPartitionsByName: Boolean
  203. def metastorePartitionPruning: Boolean
  204. def metastorePartitionPruningFallbackOnException: Boolean
  205. def metastorePartitionPruningFastFallback: Boolean
  206. def metastorePartitionPruningInSetThreshold: Int
  207. def methodSplitThreshold: Int
  208. def minBatchesToRetain: Int
  209. def nameNonStructGroupingKeyAsValue: Boolean
  210. def ndvMaxError: Double
  211. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  212. def nestedPruningOnExpressions: Boolean
  213. def nestedSchemaPruningEnabled: Boolean
  214. def nonEmptyPartitionRatioForBroadcastJoin: Double
  215. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  216. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  217. def numShufflePartitions: Int
  218. def objectAggSortBasedFallbackThreshold: Int
  219. def offHeapColumnVectorEnabled: Boolean
  220. def optimizeNullAwareAntiJoin: Boolean
  221. def optimizerExcludedRules: Option[String]
  222. def optimizerInSetConversionThreshold: Int
  223. def optimizerInSetSwitchThreshold: Int
  224. def optimizerMaxIterations: Int
  225. def optimizerMetadataOnly: Boolean
  226. def orcAggregatePushDown: Boolean
  227. def orcCompressionCodec: String
  228. def orcFilterPushDown: Boolean
  229. def orcVectorizedReaderBatchSize: Int
  230. def orcVectorizedReaderEnabled: Boolean
  231. def orcVectorizedReaderNestedColumnEnabled: Boolean
  232. def orcVectorizedWriterBatchSize: Int
  233. def orderByOrdinal: Boolean
  234. def pandasGroupedMapAssignColumnsByName: Boolean
  235. def pandasUDFBufferSize: Int
  236. def parallelFileListingInStatsComputation: Boolean
  237. def parallelPartitionDiscoveryParallelism: Int
  238. def parallelPartitionDiscoveryThreshold: Int
  239. def parquetAggregatePushDown: Boolean
  240. def parquetCompressionCodec: String
  241. def parquetFieldIdReadEnabled: Boolean
  242. def parquetFieldIdWriteEnabled: Boolean
  243. def parquetFilterPushDown: Boolean
  244. def parquetFilterPushDownDate: Boolean
  245. def parquetFilterPushDownDecimal: Boolean
  246. def parquetFilterPushDownInFilterThreshold: Int
  247. def parquetFilterPushDownStringPredicate: Boolean
  248. def parquetFilterPushDownTimestamp: Boolean
  249. def parquetInferTimestampNTZEnabled: Boolean
  250. def parquetOutputCommitterClass: String
  251. def parquetOutputTimestampType: SQLConf.ParquetOutputTimestampType.Value
  252. def parquetRecordFilterEnabled: Boolean
  253. def parquetVectorizedReaderBatchSize: Int
  254. def parquetVectorizedReaderEnabled: Boolean
  255. def parquetVectorizedReaderNestedColumnEnabled: Boolean
  256. def partitionColumnTypeInferenceEnabled: Boolean
  257. def partitionOverwriteMode: SQLConf.PartitionOverwriteMode.Value
  258. def percentileAccuracy: Int
  259. def planChangeBatches: Option[String]
  260. def planChangeLogLevel: String
  261. def planChangeRules: Option[String]
  262. def planStatsEnabled: Boolean
  263. def plannedWriteEnabled: Boolean
  264. def preferSortMergeJoin: Boolean
  265. def pysparkJVMStacktraceEnabled: Boolean
  266. def pysparkSimplifiedTraceback: Boolean
  267. def rangeExchangeSampleSizePerPartition: Int
  268. def readSideCharPadding: Boolean
  269. val reader: ConfigReader
    Attributes
    protected
  270. 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.

  271. 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.

  272. def replEagerEvalMaxNumRows: Int
  273. def replEagerEvalTruncate: Int
  274. def replaceDatabricksSparkAvroEnabled: Boolean
  275. def replaceExceptWithFilter: Boolean
  276. def resolver: Resolver

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

  277. def runSQLonFile: Boolean
  278. def runtimeFilterBloomFilterEnabled: Boolean
  279. def runtimeFilterCreationSideThreshold: Long
  280. def runtimeFilterSemiJoinReductionEnabled: Boolean
  281. def runtimeRowLevelOperationGroupFilterEnabled: Boolean
  282. def serializerNestedSchemaPruningEnabled: Boolean
  283. def sessionLocalTimeZone: String
  284. def sessionWindowBufferInMemoryThreshold: Int
  285. def sessionWindowBufferSpillThreshold: Int
  286. def setCommandRejectsSparkCoreConfs: Boolean
  287. def setConf[T](entry: ConfigEntry[T], value: T): Unit

    Set the given Spark SQL configuration property.

  288. def setConf(props: Properties): Unit

    Set Spark SQL configuration properties.

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

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

  290. def setConfWithCheck(key: String, value: String): Unit
    Attributes
    protected
  291. def setOpsPrecedenceEnforced: Boolean
  292. 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]
  293. def sortBeforeRepartition: Boolean
  294. def sortMergeJoinExecBufferInMemoryThreshold: Int
  295. def sortMergeJoinExecBufferSpillThreshold: Int
  296. def starSchemaDetection: Boolean
  297. def starSchemaFTRatio: Double
  298. def stateStoreCompressionCodec: String
  299. def stateStoreFormatValidationEnabled: Boolean
  300. def stateStoreMinDeltasForSnapshot: Int
  301. def stateStoreProviderClass: String
  302. def stateStoreSkipNullsForStreamStreamJoins: Boolean
  303. def statefulOperatorCorrectnessCheckEnabled: Boolean
  304. def storeAnalyzedPlanForView: Boolean
  305. def storeAssignmentPolicy: SQLConf.StoreAssignmentPolicy.Value
  306. def streamingFileCommitProtocolClass: String
  307. def streamingMaintenanceInterval: Long
  308. def streamingMetricsEnabled: Boolean
  309. def streamingNoDataMicroBatchesEnabled: Boolean
  310. def streamingNoDataProgressEventInterval: Long
  311. def streamingPollingDelay: Long
  312. def streamingProgressRetention: Int
  313. def streamingSchemaInference: Boolean
  314. def streamingSessionWindowMergeSessionInLocalPartition: Boolean
  315. def stringRedactionPattern: Option[Regex]
  316. def subexpressionEliminationCacheMaxEntries: Int
  317. def subexpressionEliminationEnabled: Boolean
  318. def subqueryReuseEnabled: Boolean
  319. def supportQuotedRegexColumnName: Boolean
  320. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  321. def tableRelationCacheSize: Int
  322. def timestampType: AtomicType
  323. def toString(): String
    Definition Classes
    AnyRef → Any
  324. def topKSortFallbackThreshold: Int
  325. def truncateTableIgnorePermissionAcl: Boolean
  326. def uiExplainMode: String
  327. def unsetConf(entry: ConfigEntry[_]): Unit
  328. def unsetConf(key: String): Unit
  329. def useCompression: Boolean
  330. def useCurrentSQLConfigsForView: Boolean
  331. def useDeprecatedKafkaOffsetFetching: Boolean
  332. def useNullsForMissingDefaultColumnValues: Boolean
  333. def useObjectHashAggregation: Boolean
  334. def useV1Command: Boolean
  335. def v2BucketingEnabled: Boolean
  336. def v2BucketingPartiallyClusteredDistributionEnabled: Boolean
  337. def v2BucketingPushPartValuesEnabled: Boolean
  338. def validatePartitionColumns: Boolean
  339. def variableSubstituteEnabled: Boolean
  340. def verifyPartitionPath: Boolean
  341. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  342. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  343. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  344. def warehousePath: String
  345. def wholeStageEnabled: Boolean
  346. def wholeStageMaxNumFields: Int
  347. def wholeStageSplitConsumeFuncByOperator: Boolean
  348. def wholeStageUseIdInClassName: Boolean
  349. def windowExecBufferInMemoryThreshold: Int
  350. def windowExecBufferSpillThreshold: Int
  351. def writeLegacyParquetFormat: Boolean

Inherited from Logging

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped