Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesFAQ
FAQ
You can find here frequently asked questions about Fastnate.
What types of databases are supported?
Fastnate tries to support the majority of popular databases. For a complete list see the implementations of GeneratorDialect in the dialect package. If the database of your choice is not available, it is really easy to write your own dialect.
Which JPA implementations are supported?
The first version of Fastnate was tested with Hibernate only, as this is integrated in one of the most popular application servers JBoss/WildFly. But as some details are different in other JPA implementations we plan to support those as well in our issue #1.
Which JPA features are supported?
Fastnate supports nearly all features that are necessary when creating a new project, where you can define your own database model, while it ignores some features that are only necessary in more complex scenarios. Here is a complete list of the SQL relevant annotations and enum values that are supported in the latest version:
-
@Access/AccessType -
@AssociationOverride/@AssociationOverrides -
AttributeConverter/@Converter/@Converts() (see
@Convertbelow for restrictions) -
@AttributeOverride/@AttributeOverrides -
@Basic -
@CollectionTable -
@Column -
@Convert( -
@DiscriminatorColumn/@DiscriminatorType/@DiscriminatorValue -
@ElementCollection -
@Embeddable/@Embedded -
@EmbeddedId(@MapsId, see issue #2) -
@Entity -
@Enumerated/EnumType -
@ForeignKey(Fastnate won't check for any ForeignKey constraints)
-
@GeneratedValue/GenerationType -
@Id -
@IdClass -
@Inheritance/@InheritanceType -
@JoinColumn/@JoinColumns/@JoinTable -
@Lob -
@ManyToMany/@ManyToOne/@OneToMany/@OneToOne -
@MapKey -
@MapKeyColumn/@MapKeyEnumerated/@MapKeyTemporal -
@MapKeyJoinColumn/@MapKeyJoinColumns -
@MappedSuperclass -
@MapsId -
@OrderColumn -
@PrimaryKeyJoinColumn -
@PrimaryKeyJoinColumns -
@SecondaryTable/@SecondaryTables -
@SequenceGenerator -
@Table -
@TableGenerator -
@Temporal/TemporalType -
@Transient -
@Version
(Fastnate won't check for any ForeignKey constraints)Some remarks:
- The
schemaandcatalogattributes are ignored for all...Tableannotations
Which validators are applied during creation of SQL?
Only a small subset of Bean Validators are applied:
javax.validation.constraints.NotNulljavax.validation.constraints.Size
Are mapping files supported?
No, but if you would like to use Fastnate for a project which needs mapping files, there is issue #13 which you can comment on.
Why didn't the import-data task rewrite my SQL file, I've changed something relevant?
The Fastnate import-data maven task is an incremental task. This means that it only starts the SQL generation, if something relevant has changed. How does it know that a relevant change exists? It tries to guess from the following:
- The settings have changed.
- The output file is missing.
- One of the pre-/postfix files has changed.
- One of the files from the configured data folder has changed.
- One of the changed Java files is a DataProvider, Entity, Embeddable or MappedSuperclass
If you have other Java files which are relevant for generation, you will have to implement and configure a DataChangeDetector.
I'm missing a feature in Fastnate. What can I do about it?
You can either create an issue. Or you implement that feature yourself and create a pull request.