Gazetteer 项目使用教程

1. 项目的目录结构及介绍

Gazetteer 项目的目录结构如下：

gazetteer/
├── docs/
│   └── share/
├── data/
├── .gitignore
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── Makefile
├── README.md
├── gazetteer.rb
└── postgres_sample.yml

目录结构介绍

• docs/: 包含项目文档的目录，其中 share/ 子目录可能包含共享文档。
• data/: 用于存放下载的 GeoNames 数据。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• Gemfile: 定义了项目所需的 Ruby 依赖包。
• Gemfile.lock: 锁定 Gemfile 中定义的依赖包的版本。
• LICENSE: 项目的许可证文件，采用 BSD-3-Clause 许可证。
• Makefile: 包含项目的构建和任务脚本。
• README.md: 项目的介绍和使用说明。
• gazetteer.rb: 项目的主脚本文件，用于执行各种任务。
• postgres_sample.yml: PostgreSQL 配置文件示例。

2. 项目的启动文件介绍

项目的主启动文件是 gazetteer.rb。该文件包含了项目的核心逻辑，用于执行各种任务，如设置数据库、下载数据、搜索 ISO 代码等。

主要功能

• setup: 初始化数据库，创建必要的表和数据库模式。
• code: 根据搜索词返回相应的 ISO 国家代码。
• download: 下载指定国家的 GeoNames 数据。
• metadata: 填充数据库中的地理名称元数据。

使用示例

# 初始化数据库
./gazetteer.rb setup -d geonames

# 搜索 ISO 代码
./gazetteer.rb code -s "alb"

# 下载指定国家的数据
./gazetteer.rb download -c AL

3. 项目的配置文件介绍

项目的配置文件主要是 postgres_sample.yml，这是一个 PostgreSQL 配置文件示例。该文件定义了数据库连接参数和其他相关配置。

配置文件内容示例

# PostgreSQL 配置示例
database: geonames
user: postgres
password: your_password
host: localhost
port: 5432

配置文件使用

在运行 gazetteer.rb 脚本时，可以通过指定配置文件来连接到相应的数据库。例如：

./gazetteer.rb setup -d geonames --config postgres_sample.yml

通过以上配置，项目可以正确连接到指定的 PostgreSQL 数据库并执行相应的操作。