-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added more config file documentation.
- Loading branch information
Alex Meadows
committed
Jul 24, 2014
1 parent
a4a0d06
commit 1a9ab15
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,34 @@ | ||
Data Connections | ||
================ | ||
This section describes the setting file used for all data source and target connectivity. | ||
|
||
Default Settings | ||
---------------- | ||
|
||
Here is the default sample of the ``connections.cfg`` file. This file can be found in the application settings directory, as described in :doc:`Settings <./settings>` | ||
|
||
:: | ||
|
||
[etlUnitTest] | ||
hostname: 127.0.0.1 | ||
username: root | ||
password: | ||
port: 3306 | ||
type: mysql | ||
dbname: etlUnitTest | ||
|
||
|
||
While this sample is written for MySQL/MariaDB, you can connect to any data source supported by SQLAlchemy. The full | ||
list of SQLAlchemy supported data sources can be found in their official `documentation <http://docs.sqlalchemy | ||
.org/en/rel_0_9/core/engines.html#database_urls>`_ . | ||
|
||
* ``[etlUnitTest]`` - The distinct name of the data source/target. Can be any valid string, | ||
as long as it does not break configuration file standards. | ||
* ``hostname:`` - The host name or the ip address of the system that hosts the data source/target. | ||
* ``username:`` - The username that will be used to connect to the data source/target. | ||
* ``password:`` - The password for the user account connecting to the data source/target. | ||
* ``port:`` - The port on the host that allows for connections to the data source/target. | ||
* ``type:`` - The type of data source/target being connected to. Must be compliant with the types of SQLAlchemy | ||
dialects. | ||
* ``dbname:`` - The name of the schema/database being connected to. Does not have to match the name used to define | ||
the data source/target. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,29 @@ | ||
etlTest User Properties Settings | ||
================================ | ||
This section describes the settings file used for the user's environment settings. | ||
|
||
Default Settings | ||
---------------- | ||
Here is the default sample for ``properties.cfg``. This file can be found in the application settings directory, | ||
as described in :doc:`Settings <./settings>` | ||
:: | ||
|
||
[Locations] | ||
tests: ${ETL_TEST_ROOT}/Documents/etlTest/tests | ||
data: ${ETL_TEST_ROOT}/Documents/etlTest/data | ||
output: ${ETL_TEST_ROOT}/Documents/etlTest/output | ||
[Results] | ||
Verbose: True | ||
FailureRate: 10 | ||
ReportType: Normal | ||
|
||
While the sample is written with example paths, any valid directory path can be used. If the directory does not | ||
exist, it will be created. | ||
|
||
* ``[Locations]`` - This section of the properties configuration file contains locations for the various inputs and | ||
outputs of etlTest. | ||
* ``tests:`` - The location where the YAML test files are stored. | ||
* ``data:`` - The location where the YAML data files are stored. | ||
* ``output:`` - The location where the generated test scripts are created. | ||
* ``[Results]`` - This section is currently not in use. The intent is to create user/environment based parameters | ||
for how tests are run and the results shown. The parameters underneath are just examples and are ignored by etlTest. |