dalbodeule/snap-admin
1
0
Fork 0
mirror of https://github.com/dalbodeule/snap-admin.git synced 2025-06-09 05:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added section for supported features

Browse Source
This commit is contained in:
Francesco 2023-10-05 10:01:48 +02:00
parent 2fe4eedc4b
commit c16ebff78d
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/index.html
View File

@ -114,6 +114,32 @@ dbadmin.modelsPackage=your.models.package,your.second.models.package
<p>This will autoconfigure the various Spring Boot Database Admin components when your application starts.</p> <p>This will autoconfigure the various Spring Boot Database Admin components when your application starts.</p>
<p>If everything is setup correctly, you will see Spring Boot Database Admin confirming it in the log messages that appear when you start your application. Keep in mind that if you specify the wrong models package, it will still work but provide you an empty interface. To check, visit <a target="_blank" href="http://localhost:8080/admin">http://localhost:8080/admin</a>.</p> <p>If everything is setup correctly, you will see Spring Boot Database Admin confirming it in the log messages that appear when you start your application. Keep in mind that if you specify the wrong models package, it will still work but provide you an empty interface. To check, visit <a target="_blank" href="http://localhost:8080/admin">http://localhost:8080/admin</a>.</p>
<h3 id="supported-features">2.3 Supported features</h3>
</p>
<h4>2.3.1 Supported JPA annotations</h4>
<ul>
<li><b>Core</b>: @Entity, @Table, @Column, @Lob, @Id</li>
<li><b>Relationships</b>: @OneToMany, @ManyToOne, @ManyToMany, @OneToOne</li>
</ul>
<p>The behaviour you specify with these annotations should be applied automatically by Spring Boot Database Admin as well. Keep in mind that using non-supported annotations will not necessarily result in an error, as they are simply ignored. Depending on what the annotation actually does, this could be just fine or result in an error if it interferes with something that Spring Boot Database Admin relies on.</p>
<h4>2.3.2 Supported field types</h4>
<ul>
<li>Double, Integer, Float, BigDecimal</li>
<li>Boolean</li>
<li>String</li>
<li>LocalDate, LocalDateTime</li>
<li>byte[]</li>
</ul>
<p>Unsupported field types are handled as gracefully as possible, meaning that when such a field is detected the application will run anyway but this field will never be displayed in the web interface. This also means that it will not be possible to enter the value for this field when editing or creating, leaving it as the default NULL value. If the field is not nullable, you will thus not be able to create items.</p>
<p>To check if your code contains unsupported fields:</p>
<ul>
<li>In the Spring Boot Database Admin home page, a red icon is shown next to each table if problems have been detected; click this icon to get the detailed list of errors.</li>
<li>At startup, detected unsupported field types are printed in the logs.</li>
</ul>
<div class="separator"></div> <div class="separator"></div>
<h2 id="customization">3. Customization</h2> <h2 id="customization">3. Customization</h2>
<p>There are two ways to customize the appearance and behaviour of Spring Boot Database Admin:</p> <p>There are two ways to customize the appearance and behaviour of Spring Boot Database Admin:</p>