DataClass
A DataClass fornece uma interface de objeto para uma tabela de banco de dados. Todas as lasses de um aplicativo 4D estão disponíveis como propriedade de 'ds' datastore.
Resumo
.attributeName : object |
.all ( { settings : Object } ) : 4D.EntitySelection consulta a datastore para encontrar todas as entidades relacionadas à classe de dados e as retorna como uma entity selection |
.clearRemoteCache() esvazia o cache ORDA de uma dataclass |
.fromCollection( objectCol : Collection { ; settings : Object } ) : 4D.EntitySelection atualiza ou cria entidades na dataclass de acordo com a coleção objectCol de objetos e retorna a seleção de entidades correspondente |
.get( primaryKey : Integer { ; settings : Object } ) : 4D.Entity .get( primaryKey : Text { ; settings : Object } ) : 4D.Entity consulta o dataclass para recuperar a entidade que corresponde ao parâmetro primaryKey. |
Em primaryKey, passe a chave primária da entidade para recuperar. Em primaryKey, passe o valor da chave primária da entidade a recuperar Em primaryKey, passe o valor da chave primária da entidade a recuperar O tipo valor deve coresponder com o tipo de chave primária estabelecido na datastore (Inteiro ou texto). Você também pode ter certeza de que o valor da chave primária é sempre retornado como Texto usando o . etKey()
com a função dk key como parâmetro
.
Se nenhuma entidade for encontrada com primaryKey, uma entidade Null será retornada.
É aplicado o lazy loading/carregamento diferido, ou seja os dados relacionados são carregados do disco só quando pedidos.
settings
No parâmetro opcional settings, você pode passar um objeto que contenha opções adicionais. As propriedades abaixo são compatíveis:
Propriedade | Tipo | Descrição |
---|---|---|
context | Text | Etiqueta para o contexto de otimização automático aplicados à entidade. Esse contexto será usado pelo código subsequente que carrega a entidade para que se possa beneficiar da otimização. Esta funcionalidade é concebida para processamento ORDA cliente/servidor. |
Quando você chama a função .get()
sem parâmetro configurações, uma solicitação para valores de atributos é enviada diretamente para o servidor (o [cache ORDA](. /ORDA/client-server-optimization.md#orda-cache) não é usado). Por outro lado, quando você chama o . função et()
com um context
passado no parâmetro settings, valores de atributo são recuperados do cache ORDA correspondente ao contexto. Nesse caso, pode ser aconselhável chamar [reload()
] (EntityClass.md#reload) para garantir que os dados mais recentes sejam recuperados do servidor.
Exemplo 1
var $entity : cs.EmployeeEntity
var $entity2 : cs.InvoiceEntity
$entity:=ds.Employee.get(167) // retorna a entidade cujo valor da chave primária é 167
$entity2:=ds.Invoice.get("DGGX20030") // retorna a entidade cujo valor da chave primária é "DGGX20030"
Exemplo 2
Este exemplo ilustra o uso da propriedade context:
var $e1; $e2; $e3; $e4 : cs. mployeeEntity
var $settings; $settings2 : Objeto
$settings:=Novo objeto("contexto"; de")
$settings2:=Novo objeto("contexto";"resumo")
$e1:=ds. Colaborador. et(1;$settings)
completeAllData($e1) // Em completeAllData método uma otimização é acionada e associada ao contexto "detalhe"
$e2:=ds. Colaborador. et(2;$settings)
completeAllData($e2) // Em completeAllData método a otimização associada ao "detalhe" é aplicada
$e3:=ds.Employee. et(3;$settings2)
completeSumário ($e3) //Em resumo completo, uma otimização é acionada e associada ao contexto "resumo"
$e4:=ds. mployee.get(4;$settings2)
completeSummary($e4) //In completeSummary método, a otimização associada ao contexto "resumo" é aplicada
|
| .getCount() : Integer
retorna o número de entidades em uma dataclass |
| .getDataStore() : cs.DataStore
retorna o datastore para a dataclass especificada |
| .getInfo() : Object
retorna um objeto que fornece informações sobre a dataclass |
| .getRemoteCache() : Object
|
| .new() : 4D.Entity
cria na memória e retorna uma nova entidade em branco relacionada à Dataclass |
| .newSelection( { keepOrder : Integer } ) : 4D.EntitySelection
cria uma nova seleção de entidades em branco, não compartilhável, relacionada à dataclass, na memória |
| .query( queryString : Text { ; ...value : any } { ; querySettings : Object } ) : 4D.EntitySelection
.query( formula : Object { ; querySettings : Object } ) : 4D.EntitySelection
|
| .setRemoteCacheSettings(settings : Object)
sets the timeout and maximum size of the ORDA cache for a dataclass. |
.attributeName
História
Release | Mudanças |
---|---|
19 R3 | Adicionado o atributo .exposed |
17 | Adicionado |
.attributeName : object
Descrição
Os atributos das lasses de dados são objetos que estão disponíveis diretamente como propriedades dessas classes.
Os objetos retornados têm propriedades que você pode ler para obter informações sobre os atributos da classe de dados.
Os objetos do atributo Dataclass podem ser modificados, mas a estrutura subjacente do banco de dados não será alterada.
Objeto devolvido
Os objetos atributos retornados contêm as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
autoFilled | Parâmetros | True se o valor do atributo for automaticamente preenchido por 4D. Corresponde às seguintes propriedades de campos 4D: "Autoincrement" para os campos de tipo numérico e "Auto UUID" para os campos UUID (alfa). Não retornado se .kind = "relatedEntity" ou "relatedEntities". |
exposed | Parâmetros | True se o atributo estiver exposto no REST |
fieldNumber | integer | Número interno do campo 4D do atributo. Não retornado se .kind = "relatedEntity" ou "relatedEntities". |
fieldType | Integer | Tipo de campo de banco de dados 4D do atributo. Depende do atributo kind . Valores possíveis: .kind = "storage": corresponding 4D field type pe, consulte [Value type ](https://doc.4d. om/4dv20/help/command/en/page1509.html).kind = "relatedEntity": 38 (is object ). ind = "relatedEntities": 42 (is collection ). ind = "calculado" ou "alias" = o mesmo que acima, dependendo do valor resultante (tipo de campo, relatedEntity ou relatedEntities) |
indexed | Parâmetros | True se houver um índice B-tree ou Cluster B-tree no atributo. Não retornado se .kind = "relatedEntity" ou "relatedEntities". |
inverseName | Text | Nome do atributo que está do outro lado da relação. Retornado somente quando .kind = "relatedEntity" ou "relatedEntities". |
keywordIndexed | Parâmetros | True se houver um índice de palavras-chave no atributo. Não retornado se .kind = "relatedEntity" ou "relatedEntities". |
kind | Text | Categoria do atributo. Valores possíveis:get ](../ORDA/ordaClasses. d#function-get-attributename) |
obrigatório | Parâmetros | True se a entrada de um valor null for rejeitada para o atributo. Não retornado se .kind = "relatedEntity" ou "relatedEntities". Nota: Esta propriedade corresponde à propriedade do campo "Reject NULL value input" ao nível do banco de dados 4D. Não tem relação com a propriedade existente "Mandatory"/obrigatório que é uma opção de controle de entrada de dados para uma tabela. |
name | Text | Nome do atributo como string |
path | Text | Caminho do atributo de pseudônimo baseado em uma relação |
readOnly | Parâmetros | True se o atributo for apenas de leitura. Por exemplo, atributos computados sem funçãoset são somente leitura. |
relatedDataClass | Text | Nome dadataclass relacionada ao atributo. Retornado somente quando .kind = "relatedEntity" ou "relatedEntities". |
type | Text | Tipo conceitual do valor do atributo, útil para programação genérica. Depende do atributo kind . Valores possíveis: .kind = "storage": "blob", "bool", "date", "image", "number", "object", ou "string". "number" is returned for any numeric types including duration; "string" is returned for uuid, alpha and text attribute types; "blob" attributes are blob objects..kind = "relatedEntity": related dataClass name.kind = "relatedEntities": related dataClass name + "Selection" suffix.kind = "calculated" or "alias": same as above, depending on the result |
unique | Parâmetros | True se o valor do atributo tiver que ser único. Não retornado se .kind = "relatedEntity" ou "relatedEntities". |
Para programação genérica, use Bool(attributeName.property)
, Num(attributeName.property)
ou String(attributeName.property)
(dependendo do tipo de propriedade) para obter um valor válido mesmo que a propriedade não seja retornada.
Exemplo 1
$salary:=ds. Employee.salary //returns the salary attribute in the Employee dataclass
$compCity:=ds. Company["city"] //returns the city attribute in the Company dataclass
Exemplo 2
Considerando a seguinte estrutura do banco de dados:
var $firstnameAtt;$employerAtt;$employeesAtt : Object
$firstnameAtt:=ds. Employee.firstname
//{name:firstname,kind:storage,fieldType:0,type:string,fieldNumber:2,indexed:true,
//keyWordIndexed:false,autoFilled:false,mandatory:false,unique:false}
$employerAtt:=ds. Employee.employer
//{name:employer,kind:relatedEntity,relatedDataClass:Company,
//fieldType:38,type:Company,inverseName:employees}
//38=Is object
$employeesAtt:=ds. Company.employees
//{name:employees,kind:relatedEntities,relatedDataClass:Employee,
//fieldType:42,type:EmployeeSelection,inverseName:employer}
//42=Is collection
Exemplo 3
Considerando as propriedades de tabela abaixo:
var $sequenceNumberAtt : Object
$sequenceNumberAtt=ds.Employee.sequenceNumber
//{name:sequenceNumber,kind:storage,fieldType:0,type:string,fieldNumber:13,
//indexed:true,keyWordIndexed:false,autoFilled:true,mandatory:false,unique:true}
.all()
História
Release | Mudanças |
---|---|
17 R5 | Suporte do parâmetro settings |
17 | Adicionado |
.all ( { settings : Object } ) : 4D.EntitySelection
Parâmetro | Tipo | Descrição | |
---|---|---|---|
settings | Object | -> | Opção de construção: context |
Resultados | 4D. EntitySelection | <- | Referencias sobre todas as entidades relacionadas com a classe de dados |
Descrição
A função .all()
consulta a datastore para encontrar todas as entidades relacionadas à classe de dados e as retorna como uma entity selection.
As entidades são devolvidas na ordem padrão, que é inicialmente a ordem na qual foram criadas. Note no entanto que, se as entidades foram apagas e outras adicionadas, a ordem padrão não reflete mais sua ordem de criação.
Se nenhuma entidade correspondente for encontrada, uma seleção de entidade vazia é retornada.
Se aplica carregamento diferido/lazy loading.
settings
No parâmetro opcional settings, você pode passar um objeto que contenha opções adicionais. As propriedades abaixo são compatíveis:
Propriedade | Tipo | Descrição |
---|---|---|
context | Text | Etiqueta para o contexto de otimização aplicado a seleção de entidades. Este contexto será utilizado pelo código que maneja a seleção de entidades para que possa se beneficiar da otimização. Esta funcionalidade é concebida para processamento ORDA cliente/servidor. |
Para conhecer o número total de entidades em um dataclass, é recomendado utilizar a função
getCount()
que é mais otimizada do que a expressãods.myClass.all().length
.
Exemplo
var $allEmp : cs.EmployeeSelection
$allEmp:=ds.Employee.all()
.clearRemoteCache()
História
Release | Mudanças |
---|---|
19 R5 | Adicionado |
.clearRemoteCache()
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Não exige nenhum parâmetro |
Descrição
A função .clearRemoteCache()
esvazia o cache ORDA de uma dataclass.
Esta função não reinicia os valores
timeout
emaxEntries
.
Exemplo
var $ds : 4D. DataStoreImplementation
var $persons : cs. PersonsSelection
var $p : cs. PersonsEntity
var $cache : Object
var $info : Collection
var $text : Text
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$persons:=$ds. Persons.all()
$text:="" For each ($p; $persons)
$text:=$p.firstname+" lives in "+$p.address.city+" / " End for each
$cache:=$ds. Persons.getRemoteCache()
$ds. Persons.clearRemoteCache()
// Cache of the Persons dataclass = {timeout:30;maxEntries:30000;stamp:255;entries:[]}
####Veja também
.fromCollection()
História
Release | Mudanças |
---|---|
17 R5 | Suporte do parâmetro settings |
17 | Adicionado |
.fromCollection( objectCol : Collection { ; settings : Object } ) : 4D.EntitySelection
Parâmetro | Tipo | Descrição | |
---|---|---|---|
objectCol | Collection | -> | Coleção de objetos a mapear com entidades |
settings | Object | -> | Opção de construção: context |
Resultados | 4D. EntitySelection | <- | Seleção de entidades preenchidas da coleção |
Descrição
A função .fromCollection()
atualiza ou cria entidades na dataclass de acordo com a coleção objectCol de objetos e retorna a seleção de entidades correspondente.
No parâmetro objectCol, passa uma coleção de objetos para criar novas entidades ou atualizar as existentes da classe de dados. Os nomes das propriedades devem ser os mesmos que os dos atributos da classe de dados. Se um nome de propriedade não existir na dataclass, é ignorado. Se um valor de atributo não for definido na coleção, seu valor será null.
O mapeamento entre os objetos da coleção e as entidades é feito sobre os nomes dos atributos e tipos correspondentes. Se uma propriedade de um objeto tiver o mesmo nome que um atributo de entidade mas seus tipos não corresponderem, o atributo da entidade não é preenchido.
Modo criação ou atualização
Para cada objeto de objectCol:
- Se o objeto conter uma propriedade booleana "__NEW" estabelecida em false (ou não conter uma propriedade booleana "__NEW"), a entidade se atualiza ou se cria com os valores correspondentes das propriedades do objeto. Nenhuma comprovação é realizada com respeito à chave primária:
- Se a chave primária for dada e existir, a entidade é atualizada. Nesse caso, a chave primária pode ser dada como etá ou com uma propriedade "__KEY" (preenchida com o valor da chave primária).
- Se a chave primária for dada (como é) e não existir, a entidade é criada
- Se a chave primária não for dada, a entidade é criada e o valor da chave primária é assignado com respeito às regras padrão de database.
- Se o objeto conter uma propriedade boolean "__NEW" estabelecida como true, a entidade é criada com os valores correspondente dos atributos de objeto. Uma comprovação é realizada com relação à chave primária:
- Se a chave primária for dada (como está) e existir, um erro é enviado.
- Se a chave primária for dada (como é) e não existir, a entidade é criada
- Se a chave primária não for dada, a entidade é criada e o valor da chave primária é assignado com respeito às regras padrão de database.
A propriedade "_*KEY" que contém um valor só é tida em conta quando a propriedade "**NEW" está definida como false (ou é omitida) e existe uma entidade correspondente. Em todos os outros casos, o valor da propriedade "*_KEY" é ignorado, o valor da chave primária deve ser passado "tal como está".
Entidades relacionadas
Os objetos de objectCol podem conter um ou mais objetos aninhados que apresentam uma ou mais entidades relacionadas, o que pode ser útil para criar ou atualizar links entre entidades.
Os objetos aninhados que apresentam entidades relacionadas devem conter uma propriedade "_*KEY" (preenchido com o valor da chave primária da entidade relacionada) ou o atributo de chave primária da própria entidade relacionada. O uso de uma propriedade *_KEY permite a independência do nome do atributo da chave primària.
O conteúdo das entidades relacionadas não pode ser criado / atualizado através deste mecanismo.
Stamp
Se um atributo __STAMP for dado, se realiza uma comprovação com o selo no armazén de dados e se pode devolver um erro ("O selo dado não coincide com o atual para o registro# XX da tabela XXXX"). Para obter mais informações, consulte Bloqueio de Entity.
settings
No parâmetro opcional settings, você pode passar um objeto que contenha opções adicionais. As propriedades abaixo são compatíveis:
Propriedade | Tipo | Descrição |
---|---|---|
context | Text | Etiqueta para o contexto de otimização aplicado a seleção de entidades. Este contexto será utilizado pelo código que maneja a seleção de entidades para que possa se beneficiar da otimização. Esta funcionalidade é concebida para processamento ORDA cliente/servidor. |
Exemplo 1
Queremos atualizar uma entidade existente. A propriedade __NEW não for dada, a chave primária do empregado é dada e existe:
var $empsCollection : Collection
var $emp : Object
var $employees : cs. EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.ID:=668 //PK existente na tabela Employee
$emp.firstName:="Arthur"
$emp.lastName:="Martin"
$emp.employer:=New object("ID";121) //PK existente na dataClass Company
// Para este funcionário, podemos alterar a Company usando outro PK existente na dataClass Company
$empsCollection.push($emp)
$employees:=ds. Employee.fromCollection($empsCollection)
Exemplo 2
Queremos atualizar uma entidade existente. A propriedade _*NEW não é dada, a chave primária do empregado com o atributo *_KEY e existir:
var $empsCollection : Coleção
var $emp : Objeto
var $employees : cs. ColloyeeSelection
$empsCollection:=Nova coleção
$emp:=Novo objeto
$emp. _KEY:=1720 //Existente PK na tabela
$emp.firstName:="John"
$emp. astName:="Boorman"
$emp. mployer:=Novo objeto("ID"; 21) //PK existente na dataClass Company
// Para este funcionário, podemos alterar a Empresa usando outro PK existente na dataClass
$empsCollection. ush($emp)
$employees:=ds.Empregado.fromCollection($empsCollection)
Exemplo 3
Se quiser simplesmente criar uma nova entidade da coleção::
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.firstName:="Victor"
$emp.lastName:="Hugo"
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
Exemplo
Queremos criar uma entidade. A propriedade __NEW é True, a chave primária de empregado não é dada:
var $empsCollection : Collection
var $emp : Object
var $employees : cs. EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.ID:=668 //PK existente na tabela Employee
$emp.firstName:="Arthur"
$emp.lastName:="Martin"
$emp.employer:=New object("ID";121) //PK existente na dataClass Company
// FPara este funcionário, podemos alterar a Company usando outro PK existente na dataClass Company
$empsCollection.push($emp)
$employees:=ds. Employee.fromCollection($empsCollection)
Exemplo 2
Queremos criar uma entidade. Se a propriedade __NEW é omitida, a chave primária do empregado é dada e não existir:
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=Nova coleção
$emp:=Novo objeto
$emp.ID:=10000 //Chave primária inexistente
$emp.firstName:="Françoise"
$emp.lastName:="Sagan"
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
Exemplo 6
Neste exemplo, a primeira entidade se criará e salvará mas a segunda falhará já que ambas utilizam a mesma chave primaria:
var $empsCollection : Collection
var $emp; $emp2 : Object
var $employees : cs. EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.ID:=10001 // Unexisting primary key
$emp.firstName:="Simone"
$emp.lastName:="Martin"
$emp.__NEW:=True
$empsCollection.push($emp)
$emp2:=New object
$emp2.ID:=10001 // Same primary key, already existing
$emp2.firstName:="Marc"
$emp2.lastName:="Smith"
$emp2.__NEW:=True
$empsCollection.push($emp2)
$employees:=ds. Employee.fromCollection($empsCollection)
//first entity is created
//duplicated key error for the second entity
Veja também
.get()
História
Release | Mudanças |
---|---|
17 | Adicionado |
.get( primaryKey : Integer { ; settings : Object } ) : 4D.Entity
.get( primaryKey : Text { ; settings : Object } ) : 4D.Entity
Parâmetro | Tipo | Descrição | |
---|---|---|---|
primaryKey | Integer OR Text | -> | Valor da chave primária da entidade a recuperar |
settings | Object | -> | Opção de construção: context |
Resultados | 4D. Entity | <- | Entidade que coincide com a chave primária designada |
Descrição
A função .get()
consulta o dataclass para recuperar a entidade que corresponde ao parâmetro primaryKey.
Em primaryKey, passe a chave primária da entidade para recuperar. Em primaryKey, passe o valor da chave primária da entidade a recuperar Em primaryKey, passe o valor da chave primária da entidade a recuperar O tipo valor deve coresponder com o tipo de chave primária estabelecido na datastore (Inteiro ou texto). Você também pode ter certeza de que o valor da chave primária é sempre retornado como Texto usando o . etKey()
com a função dk key como parâmetro
.
Se nenhuma entidade for encontrada com primaryKey, uma entidade Null será retornada.
É aplicado o lazy loading/carregamento diferido, ou seja os dados relacionados são carregados do disco só quando pedidos.
settings
No parâmetro opcional settings, você pode passar um objeto que contenha opções adicionais. As propriedades abaixo são compatíveis:
Propriedade | Tipo | Descrição |
---|---|---|
context | Text | Etiqueta para o contexto de otimização automático aplicados à entidade. Esse contexto será usado pelo código subsequente que carrega a entidade para que se possa beneficiar da otimização. Esta funcionalidade é concebida para processamento ORDA cliente/servidor. |
Quando você chama a função .get()
sem parâmetro configurações, uma solicitação para valores de atributos é enviada diretamente para o servidor (o [cache ORDA](. /ORDA/client-server-optimization.md#orda-cache) não é usado). Por outro lado, quando você chama o . função et()
com um context
passado no parâmetro settings, valores de atributo são recuperados do cache ORDA correspondente ao contexto. Nesse caso, pode ser aconselhável chamar [reload()
] (EntityClass.md#reload) para garantir que os dados mais recentes sejam recuperados do servidor.
Exemplo 1
var $entity : cs.EmployeeEntity
var $entity2 : cs.InvoiceEntity
$entity:=ds.Employee.get(167) // retorna a entidade cujo valor da chave primária é 167
$entity2:=ds.Invoice.get("DGGX20030") // retorna a entidade cujo valor da chave primária é "DGGX20030"
Exemplo 2
Este exemplo ilustra o uso da propriedade context:
var $e1; $e2; $e3; $e4 : cs. mployeeEntity
var $settings; $settings2 : Objeto
$settings:=Novo objeto("contexto"; de")
$settings2:=Novo objeto("contexto";"resumo")
$e1:=ds. Colaborador. et(1;$settings)
completeAllData($e1) // Em completeAllData método uma otimização é acionada e associada ao contexto "detalhe"
$e2:=ds. Colaborador. et(2;$settings)
completeAllData($e2) // Em completeAllData método a otimização associada ao "detalhe" é aplicada
$e3:=ds.Employee. et(3;$settings2)
completeSumário ($e3) //Em resumo completo, uma otimização é acionada e associada ao contexto "resumo"
$e4:=ds. mployee.get(4;$settings2)
completeSummary($e4) //In completeSummary método, a otimização associada ao contexto "resumo" é aplicada
.getCount()
História
Release | Mudanças |
---|---|
19 R5 | Adicionado |
.getCount() : Integer
Parâmetro | Tipo | Descrição | |
---|---|---|---|
resultado | Integer | <- | Número de entidades na classe de dados |
Descrição
A função .getCount()
retorna o número de entidades em uma dataclass.
Se esta função for utilizada dentro de uma transacção, as entidades criadas durante a transação serão levadas em consideração.
Exemplo
var $ds : 4D. DataStoreImplementation
var $number : Integer
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$number:=$ds. Persons.getCount()
.getDataStore()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.getDataStore() : cs.DataStore
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Resultados | cs. DataStore | <- | Informação da dataclass |
Descrição
A função .getDataStore()
retorna o datastore para a dataclass especificada.
A datastore pode ser:
- o datastore principal, como devolvido pelo comando
ds
. - uma datastore remota, aberta usando o comando
Open datastore
.
Exemplo
O método de projeto SearchDuplicate procura por valores duplicados em qualquer dataclass.
var $pet : cs.CatsEntity
$pet:=ds.Cats.all().first() //obter uma entidade
SearchDuplicate($pet;"Dogs")
// SearchDuplicate method
// SearchDuplicate(entity_to_search;dataclass_name)
#DECLARE ($pet : Object ; $dataClassName : Text)
var $dataStore; $duplicates : Object
$dataStore:=$pet.getDataClass().getDataStore()
$duplicates:=$dataStore[$dataClassName].query("name=:1";$pet.name)
.getInfo()
História
Release | Mudanças |
---|---|
19 R3 | A propriedade exposed foi adicionada |
17 R5 | Adicionado |
.getInfo() : Object
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Resultados | Object | <- | Datastore da dataclass |
Descrição
A função .getInfo()
retorna um objeto que fornece informações sobre a dataclass. Esta função é útil para configurar o código genérico.
Objeto devolvido
Propriedade | Tipo | Descrição |
---|---|---|
exposed | Parâmetros | True se a dataclass for exposta em REST |
name | Text | Nome da dataclass |
primaryKey | Text | Nome da chave primária da classe de dados |
tableNumber | Integer | Número daa tabela 4D interna |
Exemplo 1
#DECLARE ($entity : Object)
var $status : Object
computeEmployeeNumber($entity) //faz uma ação na entidade
$status:=$entity.save()
if($status.success)
ALERT("Record updated in table "+$entity.getDataClass().getInfo().name)
End if
Exemplo 2
var $settings : Object
var $es : cs.ClientsSelection
$settings:=New object
$settings.parameters:=New object("receivedIds";getIds())
$settings.attributes:=New object("pk";ds.Clients.getInfo().primaryKey)
$es:=ds.Clients.query(":pk in :receivedIds";$settings)
Exemplo 3
var $pk : Text
var $dataClassAttribute : Object
$pk:=ds.Employee.getInfo().primaryKey
$dataClassAttribute:=ds.Employee[$pk] // Se necessário, o atributo correspondente à chave primária estará acessível
.getRemoteCache()
História
Release | Mudanças |
---|---|
19 R5 | Adicionado |
.getRemoteCache() : Object
Parâmetro | Tipo | Descrição | |
---|---|---|---|
resultado | Object | <- | Objecto que descreve o conteúdo da cache ORDA para o dataclass. |
Modo avançado: Essa função é destinada a desenvolvedores que precisam personalizar os recursos padrão do ORDA para configurações específicas. Na maioria dos casos, não necessitará de o utilizar.
Descrição
A função .getRemoteCache()
retorna um objeto que contém os conteúdos do cache ORDA para um dataclass..
Chamar esta função a partir de uma aplicação 4D monousuário retorna Null
.
O objeto retornado tem as propriedades abaixo:
Propriedade | Tipo | Descrição |
---|---|---|
maxEntries | Integer | Número máximo de entradas recolhidas. |
stamp | Integer | Carimbo da cache. |
timeout | Integer | Tempo restante antes que as novas entradas na cache sejam marcadas como expiradas. |
| | Collection | Contém um objecto de entrada para cada entidade na cache. |
Cada objeto de entrada na coleção entries
possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
data | Object | Objeto que contém os dados da entrada |
expired | Parâmetros | True se a entrada tiver expirado |
| | Text | Chave primária da entidade. |
O objecto data
em cada entrada contém as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
__KEY | String | Chave primária da entidade |
__STAMP | Longint | Stamp da entidade na base de dados |
__TIMESTAMP | String | Stamp da entidade na base de dados (formato é YYYY-MM-DDTHH:MM:SS:ms:Z) |
dataClassAttributeName | Diferente de | Se houver dados na cache para um atributo dataclass, estes são devolvidos numa propriedade com o mesmo tipo que na base de dados. |
Os dados relativos a entidades relacionadas são armazenados na cache do objecto de dados.
Exemplo
No exemplo seguinte, $ds.Persons.all()
carrega a primeira entidade com todos os seus atributos. Depois, a optimização do pedido é desencadeada, pelo que apenas firstname
e address.city
são carregados.
Note que o arquivo 'address.city' está carregado no cache das 'Persons'.
Apenas a primeira entidade da dataclass Address
é armazenada na cache. É carregado durante a primeira iteração do loop.
var $ds : 4D. DataStoreImplementation
var $persons : cs. PersonsSelection
var $p : cs. PersonsEntity
var $cachePersons; $cacheAddress : Object
var $text : Text
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$persons:=$ds. Persons.all()
$text:="" For each ($p; $persons)
$text:=$p.firstname+" lives in "+$p.address.city+" / " End for each
$cachePersons:=$ds. Persons.getRemoteCache()
$cacheAddress:=$ds. Adress.getRemoteCache()
Veja também
.setRemoteCacheSettings()
.clearRemoteCache()
.new()
História
Release | Mudanças |
---|---|
17 | Adicionado |
.new() : 4D.Entity
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Resultados | 4D. Entity | <- | Nova entidade que coincide com a classe de dados |
Descrição
A função .new()
cria na memória e retorna uma nova entidade em branco relacionada à Dataclass.
O objeto entidade é criado em memória e não é salvo no banco de dados até que a função .save( )
seja chamada. Se a entidade for apagada antes de ser salva, não se pode recuperar.
4D Servidor: No servidor cliente, se a chave primária da tabela correspondente for auto-incrementada, será calculado quando a entidade for salva no servidor.
Todos os atributos da entidade são inicializados com o valor null.
Atributos podem ser inicializados com valores padrão se a opção Mapa NULL para valores em branco for selecionada no nível de estrutura de banco de dados 4D.
Exemplo
Este exemplo cria uma nova entidade na classe de dados "Log" e registra a informação no atributo "info":
var $entity : cs.LogEntity
$entity:=ds.Log.new() //create a reference
$entity.info:="Nova entrada" //armazenar alguma informação
$entity.save() //salvar a entidade
.newSelection()
História
Release | Mudanças |
---|---|
17 | Adicionado |
.newSelection( { keepOrder : Integer } ) : 4D.EntitySelection
Parâmetro | Tipo | Descrição | |
---|---|---|---|
keepOrder | Integer | -> | dk keep ordered : cria uma seleção de entidades ordenada,dk non ordered : cria uma seleção de entidade não ordenada (padrão se omitido) |
Resultados | 4D. EntitySelection | <- | Nova seleção de entidades em branco relacionadas com a classe de dados |
Descrição
A função .newSelection()
cria uma nova seleção de entidades em branco, não compartilhável, relacionada à dataclass, na memória.
Para informações sobre seleções de entidades não compartilháveis, consulte esta seção.
Se quiser criar uma seleção de entidades ordenada, passe o seletor dk keep ordered
no parâmetro keepOrder. Por padrão, se você omitir este parâmetro, ou se passar o seletor dk non ordered
, o método cria uma seleção de entidades não ordenada. As seleções de entidades desordenadas são mais rápidas mas não se pode confiar nas posições das entidades. Para mais informações, por favor consulte Seleções de entidades ordenadas vs não ordenadas.
Quando criada, a seleção de entidades não contém nenhuma entidade (mySelection.length
retorna 0). Este método permite construir seleções de entidades gradualmente fazendo chamadas subsequentes à função add()
.
Exemplo
var $USelection; $OSelection : cs.EmployeeSelection
$USelection:=ds.Employee.newSelection() //criar uma seleção vazia sem ordenação da entidade
$OSelection:=ds.Employee.newSelection(dk keep ordered) //criar uma seleção de entidade vazia ordenada
.query()
História
Release | Mudanças |
---|---|
17 R6 | Soporte dos Parâmetros Formula |
17 R5 | Suporte dos marcadores para os valores |
17 | Adicionado |
.query( queryString : Text { ; ...value : any } { ; querySettings : Object } ) : 4D.EntitySelection
.query( formula : Object { ; querySettings : Object } ) : 4D.EntitySelection
Parâmetro | Tipo | Descrição | |
---|---|---|---|
queryString | Text | -> | Criterios de pesquisa como string |
formula | Object | -> | Criterios de pesquisa como objeto fórmula |
value | any | -> | Valores a usar para placeholders indexados |
querySettings | Object | -> | Opções de pesquisa: parâmetros, atributos, args, allowFormulas, contexto, queryPath,queryPlan |
Resultados | 4D. EntitySelection | <- | Nova seleção de entidade composta por entidades da classe de dados que atendem aos critérios de pesquisa especificados em queryString ou formula |
Descrição
A função .query()
busca entidades que atendam aos critérios de pesquisa especificados em queryString ou formula e (opcionalmente) value(s), para todas as entidades na classe de dados, e retorna um novo objeto do tipo EntitySelection
contendo todas as entidades encontradas. Se aplica carregamento diferido/lazy loading.
Se nenhuma entidade correspondente for encontrada, uma EntitySelection
vazia é retornada.
parâmetro queryString
O parâmetro queryString usa a seguinte sintaxe:
attributePath|formula comparator value
{logicalOperator attributePath|formula comparator value}
{order by attributePath {desc | asc}}
onde:
- attributePath: caminho de atributo no qual se pretende executar a consulta. Os atributos se expressam como pares propriedade/ valor, onde propriedade é o nome do marcador de posição inserido para uma rota de atributo em queryString ou formula (":placeholder") e valor pode ser uma string ou uma coleção de strings. No caso de um caminho de atributo cujo tipo é
Collection
, a notação[]
é usada para lidar todas as ocorrências (por exemplochildren[].age
).
Você não pode usar diretamente atributos cujo nome contém caracteres especiais, como ". , "[ ]", ou "=", ">", "#"..., porque eles serão avaliados incorretamente na frase da consulta. Se precisar consultar tais atributos, deve considerar o uso de espaços reservados, que permite uma gama extendida de caracteres em caminhos de atributos (veja Usando espaços reservados abaixo).
-
formula: uma fórmula válida passada como
Text
ouObject
. A fórmula será avaliada para cada entidade processada e deve retornar um valor booleano. Na fórmula, a entidade está disponível através do objetoThis
.- Text: a string de fórmula deve ser precedida pela declaração
eval()
, para que o parser da consulta avalie a expressão corretamente. Por exemplo: "eval(length(This.lastname) >=30) " - Objeto: o objeto fórmula é passado como um marcador de posição (ver abaixo). A fórmula deve ter sido criada usando o comando
Fórmula
ouFormula da string
.
- Text: a string de fórmula deve ser precedida pela declaração
- Lembre que as fórmulas 4D só suportam os símbolos
&
e|
como operadores lógicos.- Se a fórmula não for o único critério de pesquisa, o otimizador de motor debusca poderia processar outros critérios previamente (por exemplo atributos indexados) e assim, a fórmula poderia ser avaliada apenas para um subconjunto de entidades.
Fórmulas nas consultas podem receber parâmetros através de $1. Este ponto está detalhado no parágrafo de fórmula abaixo.
- Você também pode passar diretamente um objeto parâmetro
formula
em vez do parâmetroqueryString
(recomendado quando as fórmulas são mais complexas). Ver o parágrafo Parâmetro fórmula mais abaixo.- Por razões de segurança, chamadas de fórmula dentro de funções
query()
podem ser desabilitadas. Consulte a descrição do parâmetroquerySettings
.
- comparator: símbolo que compara attributePath e value. Os simbolos abaixo são compatíveis:
Comparação | Símbolos | Comentário |
---|---|---|
Igual a | =, == | Retorna os dados coincidentes, admite o coringa (@), não diferencia entre maiúsculas e minúsculas nem diacríticas. |
===, IS | Retorna os dados coincidentes, considera @ como caractere padrão, não diferencia entre maiúsculas e minúsculas nem diacríticas | |
Diferente de | #, != | Suporta o coringa (@). Equivalente a "Condição não aplicada em uma declaração" (ver abaixo). |
!==, IS NOT | Considera @ como um caractere normal | |
Não se aplica à condição de uma sentença | NOT | Parentesis são obrigatórios quando usar NOT antes de uma instrução que contenha vários operadores. Equivalente a "Not equal to" (veja abaixo). |
Menor que | < | |
Maior que | > | |
Menor que ou igual a | <= | |
Maior ou igual a | > = | |
Incluído em | IN | Retorna dados iguais a ao menos um dos valores de uma coleção ou de um conjunto de valores, admite o coringa (@) |
Contém palavra chave | % | As palavras chaves podem ser usadas em atributos de string ou imagem |
- value: o valor a comparar ao valor atual da propriedade de cada entidade na seleção de entidade. Pode ser um marcador (ver Uso de marcadores abaixo) ou qualquer expressão que coincida com a propriedade de tipo de dados.
Quando usar um valor constante, as regras abaixo devem ser respeitadas:
- A constante de tipo texto pode ser passada com ou sem aspas simples (ver Uso de aspas mais abaixo). Para pesquisar uma stirng dentro de uma string (uma pesquisa "contém") use o símbolo coringa (@) em valor para isolar a string a ser pesquisada como mostrado neste exemplo: "@Smith@". As palavras chaves abaixo são proibidas para constantes de texto: true, false.
- Valores constantes de tipo booleano: true ou false (diferencia maiúscula de minúscula).
- **Valores constantes de tipo numérico: os decimais se separam com um '.' (ponto).
- constantes de tipo date: formato "YYYY-MM-DD"
- null constante: usando a palavra-chave "null" irá encontrar as propriedades null e undefined.
- no caso de uma pesquisa com um comparador IN, valor deve ser uma coleção, ou valores que coincidam com o tipo da rota do atributo entre [ ] separados por vírgulas (para as strings, os caracteres
"
devem ser escapados com\
).
- logicalOperator: usado para participar de múltiplas condições na consulta (opcional). Pode usaar um dos operadores lógicos abaixo (ou o nome ou o símbolo podem ser usados):
Conjunção | Símbolos |
---|---|
AND | &, &&, and |
OU | |,||, or |
- ordem por attributePath: você pode incluir uma ordem pela instrução attributePath na consulta, para que os dados resultantes sejam classificados de acordo com essa afirmação. Você pode usar várias ordens por declarações, separadas por vírgulas (por exemplo, ordem por attributePath1 desc, attributePath2 ascens). Como padrão, a ordem é ascendente. Passe 'desc'' para definir uma ordem descendente e 'asc' para definir uma ordem ascendente.
Se você usar essa declaração, a seleção de entidade retornada será ordenada (para mais informações, por favor consulte Seleções de entidades ordenadas vs não ordenadas).
Usar aspas
Ao usar aspas dentro das consultas, você deve usar aspas simples ' ' dentro da consulta e aspas duplas " " para envolver toda a consulta, caso contrário, será retornado um erro. Por exemplo:
"employee.name = 'smith' AND employee.firstname = 'john'"
Aspas siples (') não são permitidas nos valores pesquisados, já que quebrariam a string de pesquisa. Por exemplo, "comp.name = 'John's pizza' " gerará um erro. Se precisar pesquisar valores com aspas simples, pode considerar o uso de placeholders (ver abaixo).
Usando parêntesis
Você pode usar parênteses na consulta para dar prioridade ao cálculo. Por exemplo, pode organizar uma pesquisa da seguinte maneira:
"(employee.age >= 30 OR employee.age <= 65) AND (employee.salary <= 10000 OR employee.status = 'Manager')"
Uso de placeholders
4D lhe permite utilizar placeholders, marcadores de posição, para os argumentos attributePath, formula e value dentro do parâmetro queryString. Um placeholder é um parâmetro que você insere em cadeias de consulta e que é substituído por outro valor quando a cadeia de consulta é avaliada. O valor dos placeholders é avaliado uma vez no início da consulta; ele não é avaliado para cada elemento.
Dois tipos de marcadores podem ser usados: placeholders indexados ** e placeholders nomeados:
Marcadores de posição indexados | Placeholders nomeados | |
---|---|---|
Definição | Os parâmetros são inseridos como :paramIndex (por exemplo :1, :2...) no queryString e seus respectivos valores são fornecidos pela sequência de parâmetro(s) value. É possível utilizar até 128 parâmetros value | Os parâmetros são inseridos como :paramName (por exemplo :myparam) e seus valores são fornecidos nos atributos e/ou objetos de parâmetros no parâmetro querySettings |
Exemplo | $r:=class.query(":1=:2";"city";"Chicago") | $o.attributes:=New object("att";"city") $o.parameters:=New object("name";"Chicago") $r:=class.query(":att=:name";$o) |
É possível misturar todos os tipos de argumentos em queryString. Um queryString pode conter, para os parâmetros attributePath, formula e value:
- valores diretos (sem placeholders),
- placeholders indexados ou com nome.
O uso de placeholders em consultas é recomendado pelos seguintes motivos:
- Evita a inserção de código malicioso: se user diretamente variáveis preenchidas com uma string de pesquisa, um usuário poderia modificar as condições de pesquisa entrando argumentos adicionais. Por exemplo, imagine uma string de pesquisa como:
$vquery:="status = 'público' & nome = "+meunome //usuário entra em seu nome
$result:=$col.query($vquery)
Essa consulta parece segura, pois os dados não públicos são filtrados. No entanto, se o usuário inserir na área myname algo como "smith OR status='private',* a string de consulta será modificada na etapa de interpretação e poderá retornar dados privados.
Ao usar placeholders, não é possível substituir as condições de segurança:
$result:=$col.query("status='public' & name=:1";myname)
Neste caso, se o usuário digitar smith OR status='private' na área myname, isso não será interpretado na string de consulta, mas apenas passado como um valor. A busca por uma pessoa chamada "smith OR status='private'" simplesmente falhará.
-
Isso evita ter que se preocupar com problemas de formatação ou caracteres, especialmente ao lidar com os parâmetros attributePath ou value que podem conter caracteres não alfanuméricos, como ".", "['...
-
Permite o uso de variáveis ou expressões nos argumentos de pesquisa. Exemplos:
$result:=$col.query("address.city = :1 & name =:2";$city;$myVar+"@")
$result2:=$col.query("company.name = :1";"John's Pizzas")