GenerateDbSchema (Cyclos 4.15.15 Scripting API Documentation)

java.lang.Object
- org.cyclos.db.GenerateDbSchema

```
public class GenerateDbSchema
extends Object
```
Generates the db-schema.json file for the vanilla Cyclos schema. This class uses a docker container to start a PostgreSQL server, starts a Cyclos context and then stops the container.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GenerateDbSchema.GenerateDbSchemaConfiguration

Field Summary

Fields
Modifier and Type Field Description

static org.stro.dbdiff.LoadFromDatabaseOptions CYCLOS_DB_OPTIONS

static String DB

static String PASSWORD

static String USER

Constructor Summary

Constructors
Constructor Description

GenerateDbSchema()

GenerateDbSchema(File outFile)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`main(String[] args)`
`void`	`process(Integer portParam)`	Generates the db schema for the database "cyclos" with user "cyclos" and password "cyclos".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DB
```
public static final String DB
```
See Also:

Constant Field Values

USER
```
public static final String USER
```
See Also:

Constant Field Values

PASSWORD
```
public static final String PASSWORD
```
See Also:

Constant Field Values

CYCLOS_DB_OPTIONS

public static org.stro.dbdiff.LoadFromDatabaseOptions CYCLOS_DB_OPTIONS

Constructor Detail

GenerateDbSchema
```
public GenerateDbSchema()
```

GenerateDbSchema

public GenerateDbSchema(File outFile)

Method Detail
- main
```
public static void main(String[] args)
                 throws SQLException,
                        IOException
```
  Throws:
  
  SQLException
  
  IOException
- process
```
public void process(Integer portParam)
             throws SQLException,
                    IOException
```
  Generates the db schema for the database "cyclos" with user "cyclos" and password "cyclos".
  
  Parameters:
  
  portParam - if null it starts a new docker container, otherwise it connects to a running PostgreSQL using the given port
  
  Throws:
  
  SQLException
  
  IOException