├── .gitignore ├── requirements.txt ├── README.md ├── TUTORIAL.md ├── DIRECTIVES_AND_DATA_GENERATORS.md └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | venv/ 2 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | netaddr==0.7.18 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DataFiller - generate random data from database schema 2 | 3 | _This is a mirror of _. 4 | See that site for updated documentation. 5 | 6 | ## DESCRIPTION 7 | 8 | This script generates random data from a database schema enriched with simple 9 | directives in SQL comments to drive 29 data generators which cover typical data 10 | types and their combination. Reasonable defaults are provided, especially based 11 | on key and type constraints, so that few directives should be necessary. The 12 | minimum setup is to specify the relative size of tables with directive mult so 13 | that data generation can be scaled. 14 | 15 | See the [TUTORIAL](TUTORIAL.md) section Also, run with --validate=comics or 16 | --validate=library and look at the output for didactic examples. 17 | 18 | ## OPTIONS 19 | 20 | --debug or -D 21 | 22 | - Set debug mode. Repeat for more. Default is no debug. 23 | 24 | --drop 25 | 26 | - Drop tables before recreating them. This implies option --filter, otherwise 27 | there would be no table to fill. 28 | 29 | Default is not to. 30 | 31 | --encoding=enc or -e enc 32 | 33 | - Set this encoding for input and output files. 34 | 35 | Default is no explicit encoding. 36 | 37 | --filter or -f, reverse with --no-filter 38 | 39 | - Work as a filter, i.e. send the schema input script to stdout and then the 40 | generated data. This is convenient to pipe the result of the script directly 41 | for execution to the database command. 42 | 43 | Default is to only ouput generated data. 44 | 45 | --help or -h 46 | 47 | - Show basic help. 48 | 49 | --man or -m 50 | 51 | - Show full man page based on POD. Yes, the perl thing:-) 52 | 53 | --null RATE or -n RATE 54 | 55 | - Probability to generate a null value for nullable attributes. 56 | 57 | Default is 0.01, which can be overriden by the null directive at the schema 58 | level, or per-attributes provided null rate. 59 | 60 | --offset OFFSET or -O OFFSET 61 | 62 | - Set default offset for integer generators on primary keys. This is useful to 63 | extend the already existing content of a database for larger tests. 64 | 65 | Default is 1, which can be overriden by the offset directive at the schema 66 | level, or per-attribute provided offset. 67 | 68 | --pod COMMAND 69 | 70 | - Override pod conversion command used by option --man. 71 | 72 | Default is 'pod2usage -verbose 3'. 73 | 74 | --quiet or -q 75 | 76 | - Generate less verbose SQL output. 77 | 78 | Default is to generate one echo when starting to fill a table. 79 | 80 | --seed SEED or -S SEED 81 | 82 | - Seed overall random generation with provided string. 83 | 84 | Default uses OS supplied randomness or current time. 85 | 86 | --size SIZE 87 | 88 | - Set overall scaling. The size is combined with the mult directive value on a 89 | table to compute the actual number of tuples to generate in each table. 90 | 91 | Default is 100, which can be overriden with the size directive at the schema 92 | level. 93 | 94 | --target (postgresql|mysql) or -t ... 95 | 96 | - Target database engine. MySQL support is really experimental. 97 | 98 | Default is to target PostgreSQL. 99 | 100 | --test='directives...' 101 | 102 | - Run tests for any generator with some directives. If the directives start with 103 | !, show an histogram. If the directives start with -, show results on one-line. 104 | This is convenient for unit testing, or to check what would be the output of a 105 | set of directives. 106 | 107 | Examples: --size=100 --test='int size=10 mangle' would show 100 integers 108 | between 1 and 10 drawn uniformly. --test='!bool rate=0.3' may show False: 109 | 69.32%, True: 30.68%, stating the rate at which True and False were seen during 110 | the test. 111 | 112 | Directive type can be used within --test=... to provide the target SQL type 113 | when testing. 114 | 115 | --transaction or -T 116 | 117 | - Use a global transaction. 118 | 119 | Default is not to. 120 | 121 | --tries=NUM 122 | 123 | - How hard to try to satisfy a compound unique constraint before giving up on a 124 | given tuple. 125 | 126 | Default is 10. 127 | 128 | --truncate 129 | 130 | - Delete table contents before filling. 131 | 132 | Default is not to. 133 | 134 | --type=CUSTOM 135 | 136 | - Add a custom type. The default generator for this type will rely on a macro of 137 | the same name, if it exists. This option can be repeated to add more custom 138 | types. See also the type directive at the schema level. 139 | 140 | --validate=(unit|internal|comics|library|pgbench) 141 | 142 | - Output validation test cases. All but the unit tests can be processed with 143 | psql. 144 | 145 | sh> datafiller --validate=internal | psql 146 | 147 | This option sets --filter automatically, although it can be forced back with 148 | --no-filter. 149 | 150 | Default is to process argument files or standard input. 151 | 152 | --version, -v or -V 153 | 154 | - Show script version. 155 | -------------------------------------------------------------------------------- /TUTORIAL.md: -------------------------------------------------------------------------------- 1 | # TUTORIAL 2 | 3 | This tutorial introduces how to use DataFiller to fill a PostgreSQL database for testing functionalities and performances. 4 | 5 | ## DIRECTIVES IN COMMENTS 6 | 7 | The starting point of the script to generate test data is the SQL schema of the database taken from a file. It includes important information that will be used to generate data: attribute types, uniqueness, not-null-ness, foreign keys... The idea is to augment the schema with directives in comments so as to provide additional hints about data generation. 8 | 9 | A datafiller directive is a special SQL comment recognized by the script, with a df marker at the beginning. A directive must appear after the object about which it is applied, either directly after the object declaration, in which case the object is implicit, or much later, in which case the object must be explicitely referenced: 10 | 11 | -- this directive sets the default overall size 12 | -- df: size=10 13 | -- this directive defines a macro named "fn" 14 | -- df fn: word=/path/to/file-containing-words 15 | -- this directive applies to table "Foo" 16 | CREATE TABLE Foo( -- df: mult=10.0 17 | -- this directive applies to attribute "fid" 18 | fid SERIAL -- df: offset=1000 19 | -- use defined macro, choose "stuff" from the list of words 20 | , stuff TEXT NOT NULL -- df: use=fn 21 | ); 22 | -- ... much later 23 | -- this directive applies to attribute "fid" in table "Foo" 24 | -- df T=Foo A=fid: null=0.8 25 | 26 | 27 | ## A SIMPLE LIBRARY EXAMPLE 28 | 29 | Let us start with a simple example involving a library where readers borrow books. Our schema is defined in file library.sql as follows: 30 | 31 | 32 | CREATE TABLE Book( 33 | bid SERIAL PRIMARY KEY, 34 | title TEXT NOT NULL, 35 | isbn ISBN13 NOT NULL 36 | ); 37 | CREATE TABLE Reader( 38 | rid SERIAL PRIMARY KEY, 39 | firstname TEXT NOT NULL, 40 | lastname TEXT NOT NULL, 41 | born DATE NOT NULL, 42 | gender BOOLEAN NOT NULL, 43 | phone TEXT 44 | ); 45 | CREATE TABLE Borrow( 46 | borrowed TIMESTAMP NOT NULL, 47 | rid INTEGER NOT NULL REFERENCES Reader, 48 | bid INTEGER NOT NULL REFERENCES Book, 49 | PRIMARY KEY(bid) -- a book is borrowed once at a time! 50 | ); 51 | 52 | The first and only information you really need to provide is the relative or absolute size of relations. For scaling, the best way is to specify a relative size multiplier with the mult directive on each table, which will be multiplied by the size option to compute the actual size of data to generate in each table. Let us say we want 100 books in stock per reader, with 1.5 borrowed books per reader on average: 53 | 54 | CREATE TABLE Book( -- df: mult=100.0 55 | ... 56 | CREATE TABLE Borrow( --df: mult=1.5 57 | 58 | The default multiplier is 1.0, it does not need to be set on Reader. Then you can generate a data set with: 59 | 60 | sh> datafiller --size=1000 library.sql > library_test_data.sql 61 | 62 | Note that explicit constraints are enforced on the generated data, so that foreign keys in *Borrow* reference existing *Books* and *Readers*. However the script cannot guess implicit constraints, thus if an attribute is not declared NOT NULL, then some NULL values will be generated. If an attribute is not unique, then the generated values will probably not be unique. 63 | 64 | ## IMPROVING GENERATED VALUES 65 | 66 | In the above generated data, some attributes may not reflect the reality one would expect from a library. Changing the default with per-attribute directives will help improve this first result. 67 | 68 | First, book titles are all quite short, looking like title_number, with some collisions. Indeed the default is to generate strings with a common prefix based on the attribute name and a number drawn uniformly from the expected number of tuples. We can change to texts composed of between 1 and 7 English words taken from a dictionary: 69 | 70 | title TEXT NOT NULL 71 | -- df English: word=/etc/dictionaries-common/words 72 | -- df: text=English length=4 lenvar=3 73 | 74 | Also, we may have undesirable collisions on the ISBN attribute, because the default size of the set is the number of tuples in the table. We can extend the size at the attribute level so as to avoid this issue: 75 | 76 | isbn ISBN13 NOT NULL -- df: size=1000000000 77 | 78 | If we now look at readers, the result can also be improved. First, we can decide to keep the prefix and number form, but make the statistics more in line with what you can find. Let us draw from 1000 firstnames, most frequent 3%, and 10000 lastnames, most frequent 1%: 79 | 80 | firstname TEXT NOT NULL, 81 | -- df: sub=power prefix=fn size=1000 rate=0.03 82 | lastname TEXT NOT NULL, 83 | -- df: sub=power prefix=ln size=10000 rate=0.01 84 | 85 | The default generated dates are a few days around now, which does not make much sense for our readers' birth dates. Let us set a range of birth dates. 86 | 87 | birth DATE NOT NULL, -- df: start=1923-01-01 end=2010-01-01 88 | 89 | Most readers from our library are female: we can adjust the rate so that 25% of readers are male, instead of the default 50%. 90 | 91 | gender BOOLEAN NOT NULL, -- df: rate=0.25 92 | 93 | Phone numbers also have a prefix_number structure, which does not really look like a phone number. Let us draw a string of 10 digits, and adjust the nullable rate so that 1% of phone numbers are not known. We also set the size manually to avoid too many collisions, but we could have chosen to keep them as is, as some readers do share phone numbers. 94 | 95 | phone TEXT 96 | -- these directives could be on a single line 97 | -- df: chars='0-9' length=10 lenvar=0 98 | -- df: null=0.01 size=1000000 99 | 100 | The last table is about currently borrowed books. The timestamps are around now, we are going to spread them on a period of 50 days, that is 24 * 60 * 50 = 72000 minutes (precision is 60 seconds). 101 | 102 | borrowed TIMESTAMP NOT NULL -- df: size=72000 prec=60 103 | 104 | Because of the primary key constraint, the borrowed books are the first ones. Let us mangle the result so that referenced book numbers are scattered. 105 | 106 | bid INTEGER REFERENCES Book -- df: mangle 107 | 108 | Now we can generate improved data for our one thousand readers library, and fill it directly to our library database: 109 | 110 | sh> datafiller --size=1000 --filter library.sql | psql library 111 | 112 | Our test database is ready. If we want more users and books, we only need to adjust the size option. Let us query our test data: 113 | 114 | -- show firstname distribution 115 | SELECT firtname, COUNT(*) AS cnt FROM Reader 116 | GROUP BY firstname ORDER BY cnt DESC LIMIT 3; 117 | -- fn_1_... | 33 118 | -- fn_2_... | 15 119 | -- fn_3_... | 12 120 | -- compute gender rate 121 | SELECT AVG(gender::INT) FROM Reader; 122 | -- 0.246 123 | 124 | ## DISCUSSION 125 | 126 | We could go on improving the generated data so that it is more realistic. For instance, we could skew the borrowed timestamp so that there are less old borrowings, or skew the book number so that old books (lower numbers) are less often borrowed, or choose firtnames and lastnames from actual lists. 127 | 128 | When to stop improving is not obvious: On the one hand, real data may show particular distributions which impact the application behavior and performance, thus it may be important to reflect that in the test data. On the other hand, if nothing is really done about readers, then maybe the only relevant information is the average length of firstnames and lastnames because of the storage implications, and that's it. 129 | 130 | ## ADVANCED FEATURES 131 | 132 | Special generators allow to combine or synchronize other generators. 133 | 134 | Let us consider an new email attribute for our Readers, for which we want to generate gmail or yahoo addresses. We can use a pattern generator for this purpose: 135 | 136 | email TEXT NOT NULL CHECK(email LIKE '%@%') 137 | -- df: pattern='[a-z]{3,8}\.[a-z]{3,8}@(gmail|yahoo)\.com' 138 | 139 | The pattern sets 3 to 8 lower case characters, followed by a dot, followed by 3 to 8 characters again, followed by either gmail or yahoo domains. With this approach, everything is chosen uniformly: letters in first and last names appear 1/26, their six possible sizes between 3 to 8 are equiprobable, and each domain is drawn on average by half generated email addresses. 140 | 141 | In order to get more control about these distributions, we could rely on the chars or alt generators which can be skewed or weighted, as illustrated in the next example. 142 | 143 | Let us now consider an ip address for the library network. We want that 20% comes from librarian subnet '10.1.0.0/16' and 80% from reader subnet '10.2.0.0/16'. This can be achieved with directive alt which tells to make a weighted choice between macro-defined generators: 144 | 145 | -- define two macros 146 | -- df librarian: inet='10.1.0.0/16' 147 | -- df reader: inet='10.2.0.0/16' 148 | ip INET NOT NULL 149 | -- df: alt=reader:8,librarian:2 150 | -- This would do as well: --df: alt=reader:4,librarian 151 | 152 | Let us finally consider a log table for data coming from a proxy, which stores correlated ethernet and ip addresses, that is ethernet address always get the same ip addess, and we have about 1000 distinct hosts: 153 | 154 | -- df distinct: int size=1000 155 | , mac MACADDR NOT NULL -- df share=distinct 156 | , ip INET NOT NULL -- df share=distinct inet='10.0.0.0/8' 157 | 158 | Because of the share directive, the same mac and ip will be generated together in a pool of 1000 pairs of addresses. 159 | 160 | ## TUTORIAL CONCLUSION 161 | 162 | There are many more directives to drive data generation, from simple type oriented generators to advanced combinators. See the documentation and examples below. 163 | 164 | For very application-specific constraints that would not fit any generator, it is also possible to apply updates to modify the generated data afterwards. 165 | -------------------------------------------------------------------------------- /DIRECTIVES_AND_DATA_GENERATORS.md: -------------------------------------------------------------------------------- 1 | # DIRECTIVES AND DATA GENERATORS 2 | 3 | Directives drive the data sizes and the underlying data generators. They must appear in SQL comments after the object on which they apply, although possibly on the same line, introduced by '-- df: '. 4 | 5 | CREATE TABLE Stuff( -- df: mult=2.0 6 | id SERIAL PRIMARY KEY, -- df: step=19 7 | data TEXT UNIQUE NOT NULL -- df: prefix=st length=30 lenvar=3 8 | ); 9 | 10 | In the above example, with option --size=1000, 2000 tuples will be generated (2.0*1000) with id 1+(i*19)%2000 and unique text data of length about 30+-3 prefixed with st. The sequence for id will be restarted at 2001. 11 | 12 | The default size is the number of tuples of the containing table. This implies many collisions for a uniform generator. 13 | 14 | ## DATA GENERATORS 15 | 16 | There are 29 data generators which are selected by the attribute type or possibly directives. Most generators are subject to the null directive which drives the probability of a NULL value. There is also a special shared generator. 17 | 18 | Generators are triggered by using directives of their names. If none is specified, a default is chosen based on the attribute type. 19 | 20 | `alt` generator: 21 | This generator aggregates other generators by choosing one. The list of sub-generators must be specified as a list of comma-separated weighted datafiller macros provided by directive alt, see below. These generator definition macros must contain an explicit directive to select the underlying generator. 22 | 23 | `array` generator: 24 | This generator generates an SQL array from another generator. The sub-generator is specified as a macro name with the array directive. It takes into account the length, lenvar, lenmin and lenmax directives. 25 | 26 | `bit` generator: 27 | This generator handles BIT and VARBIT data to store sequences of bits. It takes into account the length, lenvar, lenmin and lenmax directives. 28 | 29 | `blob` generator: 30 | This is for blob types, such as PostgreSQL's BYTEA. It uses an int generator internally to drive its extent. It takes into account the length, lenvar, lenmin and lenmax directives. This generator does not support UNIQUE, but uniqueness is very likely if the blob length is significant and the size is large. 31 | 32 | `bool` generator: 33 | This generator is used for the boolean type. It is subject to the rate directive. 34 | 35 | `cat` generator: 36 | This generator aggregates other generators by concatenating their textual output. The list of sub-generators must be specified as a list of comma-separated datafiller macros provided by a cat directive, see below. 37 | 38 | `chars` generator: 39 | This alternate generator for text types generates random string of characters. It is triggered by the chars directive. In addition to the underlying int generator which allows to select values, another int generator is used to build words from the provided list of characters, The cgen directives is the name of a macro which specifies the int generator parameters for the random character selection. It also takes into account the length, lenvar, lenmin and lenmax directives. This generator does not support UNIQUE. 40 | 41 | `const` generator: 42 | This generator provides a constant text value. It is driven by the const directive. 43 | 44 | `count` generator: 45 | This generator provides a simple counter. It takes into account directives start, step and format. 46 | 47 | `date` generator: 48 | This generator is used for the date type. It uses an int generator internally to drive its extent. Its internal working is subject to directives start, end and prec. 49 | 50 | `ean` generator: 51 | This is for International Article Number (EAN!) generation. It uses an int generator internally, so the number of distinct numbers can be adjusted with directive size. It takes into account the length and prefix directives. Default is to generate EAN-13 numbers. This generator does not support UNIQUE, but uniqueness is very likely. 52 | 53 | `file` generator: 54 | Inline file contents. The mandatory list of files is specified with directive files. See also directive mode. 55 | 56 | `float` generator: 57 | This generator is used for floating point types. The directive allows to specify the sub-generator to use, see the float directive below. Its configuration also relies on directives alpha and beta. It does not support UNIQUE, but uniqueness is very likely. 58 | 59 | `inet` generator: 60 | This is for internet ip types, such as PostgreSQL's INET and CIDR. It uses an int generator internally to drive its extent. It takes into account the network directive to specify the target network. Handling IPv6 networks requires module netaddr. 61 | 62 | `int` generator: 63 | This generator is used directly for integer types, and indirectly by other generators such as text, word and date. Its internal working is subject to directives: sub, size (or mult), offset, shift, step, xor and mangle. 64 | 65 | `interval` generator: 66 | This generator is used for the time interval type. It uses the int generator internally to drive its extent. See also the unit directive. 67 | 68 | `isnull` generator: 69 | Generates the special NULL value. 70 | 71 | `luhn` generator: 72 | This is for numbers which use a Luhn's algorithm checksum, such as bank card numbers. It uses an int generator internally, so the number of distinct numbers can be adjusted with directive size. It takes into account the length and prefix directives. Default length is 16, default prefix is empty. This generator does not support UNIQUE, but uniqueness is very likely. 73 | 74 | `mac` generator: 75 | This is for MAC addresses, such as PostgreSQL's MACADDR. It uses an int generator internally, so the number of generated addresses can be adjusted with directive size. 76 | 77 | `pattern` generator: 78 | This alternative generator for text types generates text based on a regular expression provided with the pattern directive. It uses internally the alt, cat, repeat, const and chars generators. 79 | 80 | `reduce` generator: 81 | This generator applies the reduction operation specified by directive op to generators specified with reduce as a comma-separated list of macros. 82 | 83 | `repeat` generator: 84 | This generator aggregates the repetition of another generator. The repeated generator is specified in a macro with a repeat directive, and the number of repetitions relies on the extent directive. It uses an int generator internally to drive the number of repetitions, so it can be skewed by specifying a subtype with the sub directive. 85 | 86 | `string` generator: 87 | This generator is used by default for text types. This is a good generator for filling stuff without much ado. It takes into account prefix, and the length can be specified with length, lenvar lenmin and lenmax directives. The generated text is of length length +- lenvar, or between lenmin and lenmax. For CHAR(n) and VARCHAR(n) text types, automatic defaults are set. 88 | 89 | `text` generator: 90 | This aggregate generator generates aggregates of words drawn from any other generator specified by a macro in directive text. It takes into account directives separator for separator (default ), prefix and suffix (default empty). It also takes into account the length, lenvar, lenmin and lenmax directives which handle the number of words to generate. This generator does not support UNIQUE, but uniqueness is very likely for a text with a significant length drawn from a dictionary. 91 | 92 | `timestamp` generator: 93 | This generator is used for the timestamp type. It is similar to the date generator but at a finer granularity. The tz directive allows to specify the target timezone. 94 | 95 | `tuple` generator: 96 | This aggregate generator generates composite types. The list of sub-generators must be specified with tuple as a list of comma-seperated macros. 97 | 98 | `uuid` generator: 99 | This generator is used for the UUID type. It is really a pattern generator with a predefined pattern. 100 | 101 | `value` generator: 102 | This generator uses per-tuple values from another generator specified as a macro name in the value directive. If the same value is specified more than once in a tuple, the exact same value is generated. 103 | 104 | `word` generator: 105 | This alternate generator for text types is triggered by the word directive. It uses int generator to select words from a list or a file. This generator handles UNIQUE if enough words are provided. 106 | 107 | ## GLOBAL DIRECTIVES 108 | 109 | A directive macro can be defined and then used later by inserting its name between the introductory df and the :. The specified directives are stored in the macro and can be reused later. For instance, macros words, mangle cfr and cen can be defined as: 110 | 111 | --df words: word=/etc/dictionaries-common/words sub=power alpha=1.7 112 | --df mix: offset=10000 step=17 shift=3 113 | --df cfr: sub=scale alpha=6.7 114 | --df cen: sub=scale alpha=5.9 115 | 116 | Then they can be used in any datafiller directive with use=...: 117 | 118 | --df: use=words use=mix 119 | --df: use=mix 120 | 121 | Or possibly for chars generators with cgen=...: 122 | 123 | --df: cgen=cfr chars='esaitnru...' 124 | 125 | There are four predefined macros: cfr and cen define skewed integer generators with the above parameters. french, english define chars generators which tries to mimic the character frequency of these languages. 126 | 127 | The size, offset, null, seed and directives can be defined at the schema level to override from the SQL script the default size multiplier, primary key offset, null rate or seed. However, they are ignored if the corresponding options are set. 128 | 129 | The type directive at the schema level allows to add custom types, similarly the --type option above. 130 | 131 | ## TABLE DIRECTIVES 132 | 133 | `mult=float`: 134 | Size multiplier for scaling, that is computing the number of tuples to generate. This directive is exclusive from size. 135 | 136 | `nogen`: 137 | Do not generate data for this table. 138 | 139 | `null`: 140 | Set defaut null rate for this table. 141 | 142 | `size=int`: 143 | Use this size, so there is no scaling with the --size option and mult directive. This directive is exclusive from mult. 144 | 145 | `skip=float`: 146 | Skip (that is generate but do not insert) some tuples with this probability. Useful to create some holes in data. Tables with a non-zero skip cannot be referenced. 147 | 148 | ## ATTRIBUTE DIRECTIVES 149 | 150 | A specific generator can be specified by using its name in the directives, otherwise a default is provided based on the attribute SQL type. Possible generators are: alt array bit blob bool cat chars const count date ean file float inet int interval isnull luhn mac pattern reduce repeat string text timestamp tuple uuid value word. See also the sub directive to select a sub-generator to control skewness. 151 | 152 | `alt=some:2,weighted,macros:2`: 153 | List of macros, possibly weighted (default weight is 1) defining the generators to be used by an alt generator. These macros must include an explicit directive to select a generator. 154 | 155 | `array=macro`: 156 | Name of the macro defining an array built upon this generator for the array generator. The macro must include an explicit directive to select a generator. 157 | 158 | `cat=list,of,macros`: 159 | List of macros defining the generators to be used by a cat generator. These macros must include an explicit directive to select a generator. 160 | 161 | `chars='0123456789A-Z\n' cgen=macro`: 162 | The chars directive triggers the chars generator described above. Directive chars provides a list of characters which are used to build words, possibly including character intervals with '-'. A leading '-' in the list means the dash character as is. Characters can be escaped in octal (e.g. \041 for !) or in hexadecimal (e.g. \x3D for =). Unicode escapes are also supported: eg \u20ac for the Euro symbol and \U0001D11E for the G-clef. Also special escaped characters are: null \0 (ASCII 0), bell \a (7), backspace \b (8), formfeed \f (12), newline \n (10), carriage return \r (13), tab \t (9) and vertical tab \v (11). The macro name specified in directive cgen is used to setup the character selection random generator. 163 | 164 | For exemple: 165 | 166 | ... 167 | -- df skewed: sub=power rate=0.3 168 | , stuff TEXT -- df: chars='a-f' sub=uniform size=23 cgen=skewed 169 | 170 | The text is chosen uniformly in a list of 23 words, each word being built from characters 'abcdef' with the skewed generator described in the corresponding macro definition on the line above. 171 | 172 | `const=str`: 173 | Specify the constant text to generate for the const generator. The constant text can contains the escaped characters described with the chars directive above. 174 | 175 | `extent=int or extent=int-int` 176 | Specify the extent of the repetition for the repeat generator. Default is 1, that is not to repeat. 177 | 178 | `files=str`: 179 | Path-separated patterns for the list for files used by the file generator. For instance to specify image files in the ./img UN*X subdirectory: 180 | 181 | files='./img/*.png:./img/*.jpg:./img/*.gif' 182 | 183 | `float=str`: 184 | The random sub-generators for floats are those provided by Python's random: 185 | 186 | - `beta`: 187 | Beta distribution, alpha and beta must be >0. 188 | 189 | - `exp`: 190 | Exponential distribution with mean 1.0 / alpha 191 | 192 | - `gamma`: 193 | Gamma distribution, alpha and beta must be >0. 194 | 195 | - `gauss`: 196 | Gaussian distribution with mean alpha and stdev beta. 197 | 198 | - `log`: 199 | Log normal distribution, see normal. 200 | 201 | - `norm`: 202 | Normal distribution with mean alpha and stdev beta. 203 | 204 | - `pareto`: 205 | Pareto distribution with shape alpha. 206 | 207 | - `uniform`: 208 | Uniform distribution between alpha and beta. This is the default distribution. 209 | 210 | - `vonmises`: 211 | Circular data distribution, with mean angle alpha in radians and concentration beta. 212 | 213 | - `weibull`: 214 | Weibull distribution with scale alpha and shape beta. 215 | 216 | `format=str`: 217 | Format output for the count generator. Default is d. For instance, setting 08X displays the counter as 0-padded 8-digits uppercase hexadecimal. 218 | 219 | `inet=str`: 220 | Use to specify in which IPv4 or IPv6 network to generate addresses. For instance, inet=10.2.14.0/24 chooses ip addresses between 10.2.14.1 and 10.2.14.254, that is network and broadcast addresses are not generated. Similarily, inet=fe80::/112 chooses addresses between fe80::1 and fe80::ffff. The default subnet limit is 24 for IPv4 and 64 for IPv6. A leading , adds the network address, a leading . adds the broadcast address, and a leading ; adds both, thus inet=';10.2.14.0/24' chooses ip addresses between 10.2.14.0 and 10.2.14.255. 221 | 222 | `length=int lenvar=int lenmin=int lenmax=int`: 223 | Specify length either as length and variation or length bounds, for generated characters of string data, number of words of text data or blob. 224 | 225 | `mangle`: 226 | Whether to automatically choose random shift, step and xor for an int generator. 227 | 228 | `mode=str`: 229 | Mode for handling files for the file generator. The value is either blob for binaries or text for text file in the current encoding. Default is to use the binary format, as it is safer to do so. 230 | 231 | `mult=float`: 232 | Use this multiplier to compute the generator size. This directive is exclusive from size. 233 | 234 | `nogen`: 235 | Do not generate data for this attribute, so it will get its default value. 236 | 237 | `null=float`: 238 | Probability of generating a null value for this attribute. This applies to all generators. 239 | 240 | `offset=int shift=int step=int`: 241 | Various parameters for generated integers. The generated integer is offset+(shift+step*i)%size. step must not be a divider of size, it is ignored and replaced with 1 if so. 242 | 243 | Defaults: offset is 1, shift is 0, step is 1. 244 | 245 | `op=(+|*|min|max|cat)`: 246 | Reduction operation for reduce generator. 247 | 248 | `pattern=str`: 249 | Provide the regular expression for the pattern generator. 250 | 251 | They can involve character sequences like calvin, character escape sequences (octal, hexadecimal, unicode, special) as in directive chars above, character classes like [a-z] and [^a-z] (exclusion), character classes shortcuts like . \d \h \H \s and \w which stand for [ -~] [0-9] [0-9a-f] [0-9A-F] [ \f\n\r\t\v] and [0-9a-zA-Z_] respectively, as well as POSIX character classes within [:...:], for instance [:alnum:] for [0-9A-Za-z] or [:upper:] for [A-Z]. 252 | 253 | Alternations are specified with |, for instance (hello|world). Repetitions can be specified after an object with {3,8}, which stands for repeat between 3 and 8 times. The question mark ? is a shortcut for {0,1}, the star sign * for {0,8} and the plus sign + for {1,8}. 254 | 255 | For instance: 256 | 257 | stuff TEXT NOT NULL -- df: pattern='[a-z]{3,5} ?(!!|\.{3}).*' 258 | 259 | means 3 to 5 lower case letters, maybe followed by a space, followed by either 2 bangs or 3 dots, and ending with any non special character. 260 | 261 | The special [:GEN ...:] syntax allow to embedded a generator within the generated pattern, possibly including specific directives. For instance the following would generate unique email addresses because of the embedded counter: 262 | 263 | email TEXT UNIQUE NOT NULL 264 | -- df: pattern='\w+\.[:count format=X:]@somewhere\.org' 265 | 266 | `prefix=str`: 267 | Prefix for string ean luhn and text generators. 268 | 269 | `rate=float`: 270 | For the bool generator, rate of generating True vs False. Must be in [0, 1]. Default is 0.5. 271 | 272 | For the int generator, rate of generating value 0 for generators power and scale. 273 | 274 | `repeat=macro`: 275 | Macro which defines the generator to repeat for the repeat generator. See also the extent directive. 276 | 277 | `seed=str`: 278 | Set default global seed from the schema level. This can be overriden by option --seed. Default is to used the default random generator seed, usually relying on OS supplied randomness or the current time. 279 | 280 | `separator=str`: 281 | Word separator for text generator. Default is (space). 282 | 283 | `share=macro`: 284 | Specify the name of a macro which defines an int generator used for synchronizing other generators. If several generators share the same macro, their values within a tuple are correlated between tuples. 285 | 286 | `size=int`: 287 | Number of underlying values to generate or draw from, depending on the generator. For keys (primary, foreign, unique) , this is necessarily the corresponding number of tuples. This directive is exclusive from mult. 288 | 289 | `start=date/time , end=date/time, prec=int`: 290 | For the date and timestamp generators, issue from start up to end at precision prec. Precision is in days for dates and seconds for timestamp. Default is to set end to current date/time and prec to 1 day for dates et 60 seconds for timestamps. If both start and end are specified, the underlying size is adjusted. 291 | 292 | For example, to draw from about 100 years of dates ending on January 19, 2038: 293 | 294 | -- df: end=2038-01-19 size=36525 295 | 296 | `sub=SUGENERATOR`: 297 | For integer generators, use this underlying sub-type generator. 298 | 299 | The integer sub-types also applies to all generators which inherit from the int generator, namely blob date ean file inet interval luhn mac string text timestamp repeat and word. 300 | 301 | The sub-generators for integers are: 302 | 303 | - `serial`: 304 | This is really a counter which generates distinct integers, depending on offset, shift, step and xor. 305 | 306 | - `uniform`: 307 | Generates uniform random number integers between offset and offset+size-1. This is the default. 308 | 309 | - `serand`: 310 | Generate integers based on serial up to size, then use uniform. Useful to fill foreign keys. 311 | 312 | - `power` with parameter `alpha` or `rate`: 313 | Use probability to this alpha power. When rate is specified, compute alpha so that value 0 is drawn at the specified rate. Uniform is similar to power with alpha=1.0, or rate=1.0/size The higher alpha, the more skewed towards 0. 314 | 315 | Example distribution with --test='!int sub=power rate=0.3 size=10': 316 | 317 | value 0 1 2 3 4 5 6 7 8 9 318 | percent 30 13 10 9 8 7 6 6 5 5 319 | 320 | - `scale` with parameter `alpha` or `rate`: 321 | Another form of skewing. The probability of increasing values drawn is less steep at the beginning compared to power, thus the probability of values at the end is lower. 322 | 323 | Example distribution with --test='!int sub=scale rate=0.3 size=10': 324 | 325 | value 0 1 2 3 4 5 6 7 8 9 326 | percent 30 19 12 9 7 6 5 4 3 2 327 | 328 | `suffix=str`: 329 | Suffix for text generator. Default is empty. 330 | 331 | `text=macro`: 332 | Macro which defines the word provided generator for the text generator. 333 | 334 | `type=str`: 335 | At the schema level, add a custom type which will be recognized as such by the schema parser. At the attribute level, use the generator for this type. 336 | 337 | `unit=str`: 338 | The unit directive specifies the unit of the generated intervals. Possible values include s m h d mon y. Default is s, i.e. seconds. 339 | 340 | `word=file or word=:list,of,words`: 341 | The word directive triggers the word generator described above, or is used as a source for words by the text generator. Use provided word list or lines of file to generate data. The default size is the size of the word list. 342 | 343 | If the file contents is ordered by word frequency, and the int generator is skewed (see sub), the first words can be made to occur more frequently. 344 | 345 | `xor=int`: 346 | The xor directive adds a non-linear xor stage for the int generator. 347 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------