added static data documentation

This commit is contained in:
following
2013-05-08 13:53:37 +02:00
parent 05c83ab66a
commit 2c3e84c2ef
7 changed files with 168 additions and 4 deletions

View File

@@ -2,12 +2,12 @@
-- attribute_categories
-- attribute_groups
-- cache_attrib
-- cache_logtype
-- cache_report_reasons
-- cache_report_status
-- cache_size
-- cache_status
-- cache_type
-- cache_logtype
-- coordinates_type
-- countries
-- countries_list_default
@@ -15,9 +15,9 @@
-- helppages
-- languages
-- languages_list_default
-- logentries_types
-- log_types
-- log_types_text
-- logentries_types
-- news_topics
-- nodes
-- object_types

View File

@@ -0,0 +1,82 @@
Unicode Reminder: メモ
The following static data is used by the OC code. Only some of this data is
included in the Git repo distribution, but it is all included in Opencaching.de
developer VMs and databases (see http://wiki.opencaching.de/index.php/Entwicklung/Entwicklersystem).
Tables: geodb_coordinates
geodb_hierarchies
geodb_locations
geodb_textdata
Content: political geographic data
Purpose: searching for caches by city (Ortschaften)
Used by: lang/de/ocstyle/selectlocid.inc.php
lib2/logic/geodb.inc.php (not in use)
search.php
util/gns/mkadmtxt.php
Source: OpenGeoDb ?
Import: ?
License: GNU Free Documentation License ?
geodb_locations is only referenced by lib2/logic/geodb.inc.php i.e. it is
not used (yet) by OC production code.
Tables: geodb_search
Content: searching for caches by city
Used by: (not in use)
Source: OpenGeoDb
Import: util/geodb_searchindex/index.php
License: GNU Free Documentation License
There are more geodb_ tables present in OC developer and production systems,
which are undocumented, mostly empty and not in use anywhere.
Probably some unfinished experiment.
Tables: gns_locations
gns_search
Content: political geographical data
Purpose: searching for caches by city (Ortschaften)
Used by: search.php
Source: http://earth-info.nga.mil/gns/html/
Impport: util/gns/mksearchindex.php
License: Public Domain
Tables: npa_areas
npa_types
Content: German nature protection areas, as of 2009
Purpose: display NPA information for cache listings
Used by: util2/cron/modules/cache_npa_areas.class.php
Source: Bundesamt für Naturschutz
Import: ?
License: probably free to use with attribution
Docs: http://wiki.opencaching.de/index.php/Schutzgebiete
Tables: nuts_codes
nuts_layers
Content: NUTS data for adm1..adm4 levels
Purpose: assigning country, state, district, city to cache listings
Used by: util2/cron/modules/cache_location.class.php
Source: ?
Import: ?
License: probably Public Domain
Tabels: pw_dict
Content: list of common passwords
Purpose: password security tests
Used by: lib2/logic/cracklib.inc.php
Source: http://pecl.php.net/package/crack -> doc/sql/static-data/pw_dict.bz2
Import: doc/sql/static-data/pwlist.php
License: PHP License
Tables: miscellaneous, see header of data.sql
Content: all other static data
Purpose: misc
Source: doc/sql/static-data/data.sql
Import: SQL import, or bin/dbupdate.php
License: see doc/license.txt

View File

@@ -0,0 +1,20 @@
SET NAMES 'utf8';
DROP TABLE IF EXISTS `geodb_coordinates`;
CREATE TABLE `geodb_coordinates` (
`loc_id` int(11) NOT NULL default '0',
`lon` double default NULL,
`lat` double default NULL,
`coord_type` int(11) NOT NULL default '0',
`coord_subtype` int(11) default NULL,
`valid_since` date default NULL,
`date_type_since` int(11) default NULL,
`valid_until` date NOT NULL default '0000-00-00',
`date_type_until` int(11) NOT NULL default '0',
KEY `coord_loc_id_idx` (`loc_id`),
KEY `coord_lon_idx` (`lon`),
KEY `coord_lat_idx` (`lat`),
KEY `coord_type_idx` (`coord_type`),
KEY `coord_stype_idx` (`coord_subtype`),
KEY `coord_since_idx` (`valid_since`),
KEY `coord_until_idx` (`valid_until`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='static content' ;

View File

@@ -0,0 +1,32 @@
SET NAMES 'utf8';
DROP TABLE IF EXISTS `geodb_hierarchies`;
CREATE TABLE `geodb_hierarchies` (
`loc_id` int(11) NOT NULL default '0',
`level` int(11) NOT NULL default '0',
`id_lvl1` int(11) NOT NULL default '0',
`id_lvl2` int(11) default NULL,
`id_lvl3` int(11) default NULL,
`id_lvl4` int(11) default NULL,
`id_lvl5` int(11) default NULL,
`id_lvl6` int(11) default NULL,
`id_lvl7` int(11) default NULL,
`id_lvl8` int(11) default NULL,
`id_lvl9` int(11) default NULL,
`valid_since` date default NULL,
`date_type_since` int(11) default NULL,
`valid_until` date NOT NULL default '0000-00-00',
`date_type_until` int(11) NOT NULL default '0',
KEY `hierarchy_loc_id_idx` (`loc_id`),
KEY `hierarchy_level_idx` (`level`),
KEY `hierarchy_lvl1_idx` (`id_lvl1`),
KEY `hierarchy_lvl2_idx` (`id_lvl2`),
KEY `hierarchy_lvl3_idx` (`id_lvl3`),
KEY `hierarchy_lvl4_idx` (`id_lvl4`),
KEY `hierarchy_lvl5_idx` (`id_lvl5`),
KEY `hierarchy_lvl6_idx` (`id_lvl6`),
KEY `hierarchy_lvl7_idx` (`id_lvl7`),
KEY `hierarchy_lvl8_idx` (`id_lvl8`),
KEY `hierarchy_lvl9_idx` (`id_lvl9`),
KEY `hierarchy_since_idx` (`valid_since`),
KEY `hierarchy_until_idx` (`valid_until`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='static content' ;

View File

@@ -0,0 +1,8 @@
SET NAMES 'utf8';
DROP TABLE IF EXISTS `geodb_locations`;
CREATE TABLE `geodb_locations` (
`loc_id` int(11) NOT NULL default '0',
`loc_type` int(11) NOT NULL default '0',
PRIMARY KEY (`loc_id`),
KEY `loc_type_idx` (`loc_type`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='static content' ;

View File

@@ -0,0 +1,22 @@
SET NAMES 'utf8';
DROP TABLE IF EXISTS `geodb_textdata`;
CREATE TABLE `geodb_textdata` (
`loc_id` int(11) NOT NULL default '0',
`text_val` varchar(255) NOT NULL default '',
`text_type` int(11) NOT NULL default '0',
`text_locale` varchar(5) default NULL,
`is_native_lang` smallint(1) default NULL,
`is_default_name` smallint(1) default NULL,
`valid_since` date default NULL,
`date_type_since` int(11) default NULL,
`valid_until` date NOT NULL default '0000-00-00',
`date_type_until` int(11) NOT NULL default '0',
KEY `text_lid_idx` (`loc_id`),
KEY `text_val_idx` (`text_val`),
KEY `text_type_idx` (`text_type`),
KEY `text_locale_idx` (`text_locale`),
KEY `text_native_idx` (`is_native_lang`),
KEY `text_default_idx` (`is_default_name`),
KEY `text_since_idx` (`valid_since`),
KEY `text_until_idx` (`valid_until`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='static content' ;

View File

@@ -357,12 +357,12 @@ function export()
$stab[] = 'attribute_categories';
$stab[] = 'attribute_groups';
$stab[] = 'cache_attrib';
$stab[] = 'cache_logtype';
$stab[] = 'cache_report_reasons';
$stab[] = 'cache_report_status';
$stab[] = 'cache_size';
$stab[] = 'cache_status';
$stab[] = 'cache_type';
$stab[] = 'cache_logtype';
$stab[] = 'coordinates_type';
$stab[] = 'countries';
$stab[] = 'countries_list_default';
@@ -370,9 +370,9 @@ function export()
$stab[] = 'helppages';
$stab[] = 'languages';
$stab[] = 'languages_list_default';
$stab[] = 'logentries_types';
$stab[] = 'log_types';
$stab[] = 'log_types_text';
$stab[] = 'logentries_types';
$stab[] = 'news_topics';
$stab[] = 'nodes';
$stab[] = 'object_types';