Creating a DataFakery Project
This guide will walk you through the steps to create a new DataFakery project using the project wizard. Follow these simple instructions to get started.
Last updated
Was this helpful?
This guide will walk you through the steps to create a new DataFakery project using the project wizard. Follow these simple instructions to get started.
Last updated
Was this helpful?
Creating a new project with DataFakery is quick and easy. Simply click the large '+' button in your sidebar and select 'New Project' from the menu that appears.
Enter the Project Name: Click on the text box labeled "New Project" and type in the name of your new project. This name will help you identify your project later.
You have two options for defining the data source for your project:
Use Existing Data Source
Select this option if you want to use data from an existing database such as MS SQL Server, MySQL, or PostgreSQL.
Create Data from Scratch
Select this option if you want to create a new dataset from scratch and export it to a CSV file. This option is useful if you do not have an existing database and wish to generate new data.
In this step, you will configure the data source settings for your DataFakery project. Follow these instructions to set up your data source correctly.
Choose the Database Type: On the left side of the form, select the type of database you are connecting to. Options include:
SQL Server
MySQL
PostgreSQL
Connection Name: Enter a name for your database connection in the "Connection Name" field. This name will help you identify this specific connection later.
Server: Enter the server address where your database is hosted.
Database: Enter the name of the database you wish to connect to.
Authentication: Choose the authentication method from the dropdown menu. Options typically include:
Windows Authentication
SQL Server Authentication (or equivalent for MySQL/PostgreSQL)
Username and Password: If required by your authentication method, enter the username and password needed to access the database.
Advanced: Click on the "Advanced" tab to configure any advanced settings for your database connection.
Additional Parameters: Click on the "Additional Parameters" tab to set any additional parameters that your connection might require.
Click the "Test connection" button to ensure that the provided details are correct and that you can successfully connect to the database.
If you wish to use a Docker container as a data source, click on "Use Docker Container." The displayed window will show you all available Docker instances on your machine. You can select an available Docker container if it's a supported data source such as PostgreSQL, MSSQL, or MySQL. DataFakery will try to extract the database connection string based on the metadata of the Docker container. Simply click on "Use as Data Source" to proceed. See Docker Integration for further details.
In this step, you will configure the appearance and theme settings for your DataFakery project. Follow these instructions to customize your project environment.
Simple Mode:
Select "Simple" if you prefer a streamlined interface suitable for most use cases. This mode is recommended for users who want an easy and straightforward experience.
Expert Mode:
Select "Expert" if you need access to advanced features and configurations. This mode is ideal for users with more complex requirements or those who are familiar with detailed settings.
Dark Theme:
Choose "Dark Theme" for a dark interface that is easier on the eyes in low-light environments.
Light Theme:
Choose "Light Theme" for a bright and clear interface that is suitable for well-lit environments.
Note: You can switch between different themes, skins, and palettes later if needed.
To finish the project creation, click on "Finish" and save the file. You have just completed the wizard, and your project will now be loaded.
Ensure the project name is unique and descriptive to avoid confusion with other projects.
If you are using an existing data source, make sure you have the necessary credentials and permissions to access the database.
By following these steps, you will successfully initiate a new project in the DataFakery Project Wizard. Continue through the subsequent steps of the wizard to configure and finalize your project settings.
Happy data faking!
