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 gatherFastStats: Boolean
  107. 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.

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

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

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

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

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

  114. 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" )
  115. def groupByAliases: Boolean
  116. def groupByOrdinal: Boolean
  117. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  118. def hintErrorHandler: HintErrorHandler

    Returns the error handler for handling hint errors.

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

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

  238. def replEagerEvalMaxNumRows: Int
  239. def replEagerEvalTruncate: Int
  240. def replaceDatabricksSparkAvroEnabled: Boolean
  241. def replaceExceptWithFilter: Boolean
  242. def resolver: Resolver

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

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

    Set the given Spark SQL configuration property.

  250. def setConf(props: Properties): Unit

    Set Spark SQL configuration properties.

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

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

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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped