README
¶
cnregion
历年统计用区域和城乡划分代码，数据来源于 https://www.stats.gov.cn/sj/tjbz/tjyqhdmhcxhfdm/。 符合国家标准 GB/T 2260 与 GB/T 10114。
关于版本号，主版本号代码不兼容性更改，次版本号代码最后一次生成的数据年份，BUG 修正和兼容性的功能增加则增加修订版本号。
v, err := cnregion.LoadFile("./data/regions.db", "-", 2020)
p := v.Provinces() // 返回所有省列表
cities := p[0].Items() // 返回该省下的所有市
counties := cities[0].Items() // 返回该市下的所有县
towns := counties[0].Items() // 返回所有镇
villages := towns[0].Items() // 所有村和街道信息
d := v.Districts() // 按以前的行政大区进行划分
provinces := d[0].Items() // 该大区下的所有省份
list := v.Search(&SearchOptions{Text: "温州"}) // 按索地名中带温州的区域列表
对采集的数据进行了一定的加工，以减少文件的体积，文件保存在 ./data/regions.db 中。
安装
go get github.com/issue9/cnregion/v2
版权
Documentation
¶
Overview ¶
Package cnregion 中国区域划分代码
Index ¶
- Constants
- Variables
- type DB
- func (db *DB) AddItem(regionID, name string, ver int) error
- func (db *DB) AddVersion(ver int) (ok bool)
- func (db *DB) Districts() []*Region
- func (db *DB) Dump(file string, compress bool) error
- func (db *DB) Find(regionID string) *Region
- func (db *DB) Provinces() []*Region
- func (db *DB) Search(opt *Options) []*Region
- func (db *DB) Versions() []int
- type Options
- type Region
Constants ¶
View Source
const Version = 1
Version 数据文件的版本号
Variables ¶
View Source
var ErrIncompatible = errors.New("数据文件版本不兼容")
ErrIncompatible 数据文件版本不兼容
当数据文件中指定的版本号与当前的 Version 不相等时，返回此错误。
Functions ¶
This section is empty.
Types ¶
type DB ¶
type DB struct {
// contains filtered or unexported fields
}
DB 区域数据库信息
数据格式：
1:[versions]:{id:name:yearIndex:size{}}
- 1 表示数据格式的版本，采用当前包的 Version 常量；
- versions 表示当前数据文件中的数据支持的年份列表，以逗号分隔；
- id 当前区域的 ID；
- name 当前区域的名称；
- yearIndex 此条数据支持的年份列表，每一个位表示一个年份在 versions 中的索引值；
- size 表示子元素的数量；
type Options ¶
type Options struct {
// 表示你需要搜索的地名需要包含的内容
//
// 不能是多个名称的组合，比如"浙江温州"，直接写"温州"就可以。
// 也不要提供类似于"居委会"这种无实际意义的地名；
Text string
// 上一级的区域 ID
//
// 为空表示不限制。
Parent string
// 搜索的城市类型
//
// 该值取值于 github.com/issue9/cnregion/v2/id.Level 类型。 多个值可以通过或运算叠加。
// 0 表示所有类型。
Level id.Level
// 最大的搜索数量。0 表示不限制数量。
Max int
// contains filtered or unexported fields
}
Options 搜索选项
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.