Module bau.municipio
Funções relacionadas à tabela bau.municipio.
Functions
| lista (db, id_unidade_federacao) | Lista as cidades de uma unidade da federação. |
| id2nome_id (db, id_municipio) | Obtém o nome e a unidade da federação onde se encontra o município dado. |
| dados (db, id_municipio, mode) | Obtém os dados do município. |
| busca_por_nome (db, str) | Busca pelo nome de um município. |
| checa_uf (db, id_municipio, id_municipio) | Confere se um município faz parte de uma unidade da federação. |
Functions
- lista (db, id_unidade_federacao)
-
Lista as cidades de uma unidade da federação.
Parameters:
- db Objeto de conexão com o banco.
- id_unidade_federacao Identificador da unidade da federação (opcional; pode ser uma tabela).
Returns:
-
Iterador que retorna o identificador do município, o código da
unidade da federação onde se encontra e o nome.
- id2nome_id (db, id_municipio)
-
Obtém o nome e a unidade da federação onde se encontra o município dado.
Parameters:
- db Objeto de conexão com o banco.
- id_municipio Identificador do município (aceita subselect).
Returns:
- String com o nome do município.
- Identificador do município.
- dados (db, id_municipio, mode)
-
Obtém os dados do município.
Parameters:
- db Objeto de conexão com o banco.
- id_municipio Identificador do município (aceita subselect).
- mode String com o modo de obtenção dos dados ('a' ou 'n') ou com a lista de campos que se quer (opcional).
Returns:
- String com o nome do município OU Tabela com os dados (se mode for 'a' ou 'n').
- Identificador da unidade da federação onde se encontra.
- Identificador do município.
- busca_por_nome (db, str)
-
Busca pelo nome de um município.
Parameters:
- db Objeto de conexão com o banco.
- str String com trecho do nome do município.
Returns:
-
Iterador que retorna:
Identificador do município ou nil, caso não encontre.
String com o nome do município.
Identificador da unidade da federação onde se encontra.
- checa_uf (db, id_municipio, id_municipio)
-
Confere se um município faz parte de uma unidade da federação.
Parameters:
- db Objeto de conexão com o banco.
- id_municipio Identificador do município.
- id_municipio Identificador do município.
Returns:
-
Booleano indicando se o município faz parte da unidade da federação
dada.