.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "UR::Env 3pm" .TH UR::Env 3pm "2019-01-02" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" UR::Env \- Environment variables that control UR behavior .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1UR\s0 uses several environment variables to change its behavior or provide additional debugging information. .IP "\s-1UR_STACK_DUMP_ON_DIE\s0 " 4 .IX Item "UR_STACK_DUMP_ON_DIE " When true, has the effect of turning any \fBdie()\fR into a Carp::confess, meaning a stack dump will be printed after the die message. .IP "\s-1UR_STACK_DUMP_ON_WARN\s0 " 4 .IX Item "UR_STACK_DUMP_ON_WARN " When true, has the effect of turning any \fBwarn()\fR into a Carp::cluck, meaning a stack dump will be printed after the warn message. .IP "\s-1UR_CONTEXT_ROOT\s0 " 4 .IX Item "UR_CONTEXT_ROOT " The name of the Root context to instantiate when the program initializes. The default is UR::Context::DefaultRoot. Other Root Contexts can be used, for example, to connect to alternate databases when running in test mode. .IP "\s-1UR_CONTEXT_BASE\s0 " 4 .IX Item "UR_CONTEXT_BASE " This value only changes in a sub-process which goes to its parent process for object I/O instead of the root (which is the default value for the base context in an application). .IP "\s-1UR_CONTEXT_CACHE_SIZE_HIGHWATER\s0 " 4 .IX Item "UR_CONTEXT_CACHE_SIZE_HIGHWATER " Set the object count highwater mark for the object cache pruner. See also \&\*(L"object_cache_size_highwater\*(R" in UR::Context .IP "\s-1UR_CONTEXT_CACHE_SIZE_LOWWATER\s0 " 4 .IX Item "UR_CONTEXT_CACHE_SIZE_LOWWATER " Set the object count lowwater mark for the object cache pruner. See also \&\*(L"object_cache_size_lowwater\*(R" in UR::Context .IP "\s-1UR_DEBUG_OBJECT_RELEASE\s0 " 4 .IX Item "UR_DEBUG_OBJECT_RELEASE " When true, messages will be printed to \s-1STDERR\s0 whenever objects are removed from the object cache, such as when the object pruner marks them for removal, when they are garbage collected, unloaded, or deleted. .IP "\s-1UR_DEBUG_OBJECT_RELEASE\s0 " 4 .IX Item "UR_DEBUG_OBJECT_RELEASE " When true, messages will be printed to \s-1STDERR\s0 whenever the object pruner finishes its work, and show how many objects of each class were marked for removal. .IP "\s-1UR_CONTEXT_MONITOR_QUERY\s0 " 4 .IX Item "UR_CONTEXT_MONITOR_QUERY " When true (non-zero), messages will be printed as the Context satisfies queries, such as when \fBget()\fR is called on a class, or while processing an iterator created through SomeClass\->create_iterator and iterator\->\fBnext()\fR. If the value is 1, then only queries about Non-UR classes are printed. If 2, then all queries' information is printed. .IP "\s-1UR_DBI_MONITOR_SQL\s0 " 4 .IX Item "UR_DBI_MONITOR_SQL " If this is true, most interactions with data sources such as connecting, disconnecting and querying will print messages to \s-1STDERR.\s0 Same as \&\f(CW\*(C`UR::DBI\->monitor_sql()\*(C'\fR. Note that this affects non-DBI data sources as well, such as file-based data sources, which will render file I/O information instead of \s-1SQL.\s0 .IP "\s-1UR_DBI_SUMMARIZE_SQL\s0 " 4 .IX Item "UR_DBI_SUMMARIZE_SQL " If true, a report will be printed to \s-1STDERR\s0 as the program finishes about what \&\s-1SQL\s0 queries have been done during the program's execution, and how many times they were executed. This is helpful during optimization. .IP "\s-1UR_DBI_MONITOR_EVERY_FETCH\s0 " 4 .IX Item "UR_DBI_MONITOR_EVERY_FETCH " Used in conjunction with \s-1UR_DBI_MONITOR_SQL,\s0 tells the data sources to also print messages to \s-1STDERR\s0 for each row fetched from the underlying data source. Same as \f(CW\*(C`UR::DBI\->monitor_every_fetch()\*(C'\fR. .IP "\s-1UR_DBI_DUMP_STACK_ON_CONNECT\s0 " 4 .IX Item "UR_DBI_DUMP_STACK_ON_CONNECT " Print a message to \s-1STDERR\s0 only when connecting to an underlying data source. Same as \f(CW\*(C`UR::DBI\->dump_stack_on_connect()\*(C'\fR .IP "\s-1UR_DBI_EXPLAIN_SQL_MATCH\s0 " 4 .IX Item "UR_DBI_EXPLAIN_SQL_MATCH " If the query to a data source matches the given string (interpreted as a regex), then it will attempt to do an \*(L"explain plan\*(R" and print the results before executing the query. Same as \f(CW\*(C`UR::DBI\->explain_sql_match()\*(C'\fR .IP "\s-1UR_DBI_EXPLAIN_SQL_SLOW\s0 " 4 .IX Item "UR_DBI_EXPLAIN_SQL_SLOW " If the time between a prepare and the first fetch of a query is longer than the given number of seconds, then it will do an \*(L"explain plan\*(R" and print the results. Same as \f(CW\*(C`UR::DBI\->explain_sql_slow()\*(C'\fR .IP "\s-1UR_DBI_EXPLAIN_SQL_CALLSTACK\s0 " 4 .IX Item "UR_DBI_EXPLAIN_SQL_CALLSTACK " Used in conjunction with \s-1UR_DBI_EXPLAIN_SQL_MATCH\s0 and \s-1UR_DBI_EXPLAIN_SQL_SLOW,\s0 prints a stack trace with Carp::longmess. Same as \f(CW\*(C`UR::DBI\->explain_sql_callstack()\*(C'\fR .IP "\s-1UR_DBI_MONITOR_DML\s0 " 4 .IX Item "UR_DBI_MONITOR_DML " Like \s-1UR_DBI_MONITOR_SQL,\s0 but only prints information during data-altering statements, like \s-1INSERT, UPDATE\s0 or \s-1DELETE.\s0 Same as \f(CW\*(C`UR::DBI\->monitor_dml()\*(C'\fR .IP "\s-1UR_DBI_NO_COMMIT\s0 " 4 .IX Item "UR_DBI_NO_COMMIT " If true, data source commits will be ignored. Note that saving still occurs. If you are working with a \s-1RDBMS\s0 database, this means During UR::Context\->\fBcommit()\fR, the insert, update and delete \s-1SQL\s0 statements will be issued, but the changes will not be committed. Useful for testing. Same as \f(CW\*(C`UR::DBI\->no_commit()\*(C'\fR .IP "\s-1UR_USE_DUMMY_AUTOGENERATED_IDS\s0 " 4 .IX Item "UR_USE_DUMMY_AUTOGENERATED_IDS " If true, objects created without \s-1ID\s0 params will use a special algorithm to generate IDs. Objects with these special IDs will never be saved to a data source. Useful during testing. Same as \f(CW\*(C`UR::DataSource\->use_dummy_autogenerated_ids\*(C'\fR .IP "\s-1UR_USED_LIBS\s0" 4 .IX Item "UR_USED_LIBS" If true, prints a message to \s-1STDERR\s0 with the contents of \f(CW@INC\fR just before the program exits. .IP "\s-1UR_USED_MODS\s0" 4 .IX Item "UR_USED_MODS" If true, prints a message to \s-1STDERR\s0 with the keys of \f(CW%INC\fR just before the program exits. This will be a list of what modules had been loaded during the life of the program. If \s-1UR_USED_MODS\s0 is greater than 1, then it will show the key/value pairs of \f(CW%INC\fR, which will show the path each module was loaded from.