Platform (requery API)

All Known Implementing Classes:

Derby, Generic, H2, HSQL, MySQL, Oracle, PlatformDelegate, PostgresSQL, SQLite, SQLServer
```
public interface Platform
```
Defines platform/vendor specific SQL features.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addMappings(Mapping mapping)` Given the attribute and `FieldType` allows the platform to replace the storage type with a platform specific one.
`GeneratedColumnDefinition`	`generatedColumnDefinition()`
`Generator<LimitedElement>`	`limitGenerator()`
`Generator<OrderByElement>`	`orderByGenerator()`
`boolean`	`supportsAddingConstraint()`
`boolean`	`supportsGeneratedColumnsInPrepareStatement()`
`boolean`	`supportsGeneratedKeysInBatchUpdate()`
`boolean`	`supportsIfExists()`
`boolean`	`supportsInlineForeignKeyReference()`
`boolean`	`supportsUpsert()`
`Generator<Map<Expression<?>,Object>>`	`upsertGenerator()`
`VersionColumnDefinition`	`versionColumnDefinition()`

- Method Detail
  - addMappings
```
void addMappings(Mapping mapping)
```
    Given the attribute and FieldType allows the platform to replace the storage type with a platform specific one. Substitution occurs both for table generation and entity property conversion.
    
    Parameters:
    
    mapping - mapping containing type information of what is being read or written.
  - supportsInlineForeignKeyReference
```
boolean supportsInlineForeignKeyReference()
```
    Returns:
    
    false if the database requires foreign keys to be defined as columns in the create table statement. true if they can be inlined in one statement.
  - supportsAddingConstraint
```
boolean supportsAddingConstraint()
```
    Returns:
    
    true if the database supports adding a constraint (e.g. foreign key) after the column is created (or if it requires it). In most DDL statements the column is created first and then the constraint is added.
  - supportsIfExists
```
boolean supportsIfExists()
```
    Returns:
    
    true if the database supports the 'if exists' syntax in the create table/index, drop DDL statements.
  - supportsGeneratedColumnsInPrepareStatement
```
boolean supportsGeneratedColumnsInPrepareStatement()
```
    Returns:
    
    true if the JDBC Connection.prepareStatement(String, String[]) method should be used to get the generated key set when inserting records.
  - supportsGeneratedKeysInBatchUpdate
```
boolean supportsGeneratedKeysInBatchUpdate()
```
    Returns:
    
    true if the JDBC driver supports reading generated keys via Statement.getGeneratedKeys().
  - supportsUpsert
```
boolean supportsUpsert()
```
    Returns:
    
    true if the platform supports an upsert (insert or update) operation either via merge or an alternate syntax that is defined in upsertGenerator()
  - generatedColumnDefinition
```
GeneratedColumnDefinition generatedColumnDefinition()
```
    Returns:
    
    the type of generated key type DDL this database supports.
  - limitGenerator
```
Generator<LimitedElement> limitGenerator()
```
    Returns:
    
    the limit generator for this database
  - upsertGenerator
```
Generator<Map<Expression<?>,Object>> upsertGenerator()
```
    Returns:
    
    the upsert generator for this database
  - orderByGenerator
```
Generator<OrderByElement> orderByGenerator()
```
    Returns:
    
    the order by generator for this database
  - versionColumnDefinition
```
VersionColumnDefinition versionColumnDefinition()
```
    Returns:
    
    the type of version column this database supports.

Interface Platform

Method Summary

Method Detail

addMappings

supportsInlineForeignKeyReference

supportsAddingConstraint

supportsIfExists

supportsGeneratedColumnsInPrepareStatement

supportsGeneratedKeysInBatchUpdate

supportsUpsert

generatedColumnDefinition

limitGenerator

upsertGenerator

orderByGenerator

versionColumnDefinition