Usina BRAdvPL Guia
Entrar
← Todos os tópicos
FUNçãOPublicado

TCSqlExec

TCSqlExec( <cComandoSQL> ) --> nRet

Executa um comando SQL diretamente via TopConn/DBAccess.

SQLTopConnDBAccessBanco de dadosFunções essenciais
01 · VISÃO GERAL

Visão geral

TCSqlExec() executa comandos SQL que não retornam cursor de consulta, como instruções de atualização, criação temporária ou manutenção controlada. Deve ser usada com muito critério, porque contorna parte das proteções usuais das rotinas de negócio do Protheus.

02 · SINTAXE

Sintaxe

TCSqlExec( <cComandoSQL> ) --> nRet

Parâmetros

cComandoSQL
CaracterObrigatório

Comando SQL enviado ao banco de dados por meio do DBAccess/TopConn.

Retorno

Numérico. Retorna o código de execução informado pela camada TopConn/DBAccess; valide o comportamento no ambiente e versão utilizados.

03 · EXEMPLO PRÁTICO

Executar comando SQL controlado

#Include "TOTVS.ch"

User Function ExTCSqlExec()
    Local cSql := "UPDATE " + RetSqlName("SA1") + " SET A1_XOBS = 'OK' WHERE D_E_L_E_T_ = ' ' AND A1_COD = '000001'"
    Local nRet := TCSqlExec(cSql)

    MsgInfo("Retorno SQL: " + CValToChar(nRet))
Return
Resultado esperado

Executa um UPDATE restrito por chave e mostra o código de retorno. Use apenas como exemplo didático e valide em homologação.

BOAS PRÁTICAS
  • Use TCSqlExec() para comandos SQL sem cursor de retorno.
  • Para leitura de dados, prefira TCQUERY quando a intenção for percorrer um resultado.
  • Em tabelas Protheus, respeite filial, D_E_L_E_T_ e regras de negócio antes de escrever diretamente.
ARMADILHAS COMUNS
  • Evite montar SQL com concatenação de dados de usuário sem tratamento.
  • Não use para atualizar tabelas de negócio quando existir API, rotina ou mecanismo oficial mais seguro.
  • Teste em homologação: um comando SQL direto pode afetar muitos registros rapidamente.

Conteúdos relacionados

REFERÊNCIAS
  1. RXM Tecnologia. 20 funções AdvPL essenciais que todo dev Protheus usa. Maycon Motta da Silva, maio de 2026. Disponível em: https://rxmtecnologia.com.br/blog/20-funcoes-advpl-essenciais-que-todo-dev-protheus-usa.
Situação
Publicado
Página criada em
Última revisão em
Idioma original
Português
Revisão
Usina.BR
0 comentário(s) aprovado(s)

Comentários

Ainda não há comentários aprovados.

Entre com Google ou Microsoft para comentar.

Powered by Usina Docs · Alpha