• syntax
  • entities and fields
  • comparison operators
  • field criteria
  • relative time operators
• search
  • find in files by name/pattern
  • find items (folder) some times ago by aql
• sort and limit
  • find most recent item
  • find and pagination (sort and limit)
• specify output fields
  • example
• call aql via CURL
  • running via curl -d
  • running via curl -T

[!TIP|label:references:]

• jfrog/artifactory-scripts
• Artifactory Query Language (AQL)
• Artifactory Query Language | Artifactory Query Language (AQL)
  • Using AQL With Remote Repositories
  • Using AQL With Virtual Repositories
• Advanced Cleanup Using Artifactory Query Language (AQL)

syntax

entities and fields

comparison operators

field criteria

• example

  // find items whose "name" field matches the expression "*test.*"
  items.find({"name": {"$match" : "*test.*"}})
  
  // find items that have been downloaded over 5 times.
  // we need to include the "stat" specifier in "stat.downloads" since downloads is a field of the stat domain and not of the item domain.
  items.find({"stat.downloads":{"$gt":"5"}})
  
  // find items that have never been downloaded. note that when specifying zero downloads we use "null" instead of 0.
  // we need to include the "stat" specifier in "stat.downloads" since downloads is a field of the stat domain and not of the item domain.
  items.find({"stat.downloads":{"$eq":null}})
  
  // find builds that use a dependency that is a snapshot
  builds.find({"module.dependency.item.name":{"$match":"*SNAPSHOT*"}})
  

relative time operators

[!NOTE|label:references:]

• aqlCleanup.groovy
• Advanced Cleanup Using Artifactory Query Language (AQL)

AQL supports specifying time intervals for queries using relative time. In other words, the time interval for the query will always be relative to the time that the query is run, so you don't have to change or formulate the time period, in some other way, each time the query is run. For example, you may want to run a query over the last day, or for the time period up to two weeks ago.

relative time is specified using the following two operators:

Time periods are specified with a number and one of the following suffixes:

search

find in files by name/pattern

[!NOTE|label:verbose]

• RT_URL: https://artifactory.sample.com/artifactory
• account: username
• password: password or API token

same repo with curl -d

$ curl -fsSL -u ${account}:${password} \
       -X POST ${RT_URL}/api/search/aql \
       -H "Content-Type: text/plain" \
       -d 'items.find(
            {"repo" : "repo-name"},
            {"path" : {"$match":"*path/to/folder*"}},
            {"name" : {"$match":"name-*.json"}}
          ).include( "repo","path","name","created","updated","actual_md5","actual_sha1" )
          '
# or
$ curl -s -u ${account}:${password} \
       -X POST "${RT_URL}api/search/aql" \
       -H 'content-type: text/plain' \
       -d 'items.find ({
            "path" : { "\$ne" : "." },
            "\$or" : [{
              "\$and" : [{
                "repo" : "${repo}",
                "path" : { "\$match": "${path}" } ,
                "name" : { "\$match": "${name}" }
              }]
            },
            { "\$and" : [{
                  "repo" : "${repo}",
                  "path" : { "\$match" : "${path}/*" } ,
                  "name" : { "\$match" : "${name}"}
              }]
            }]
          }).include( "name","repo","path","actual_md5","actual_sha1","size","type","property" )
          '

search in same repo with curl -T

items.find(
  {"repo" : "repo-name"},
  {"path" : {"$match":"path/to/folder*"}},
  {"name" : {"$match":"name-*.json"}}
).include( "repo","path","name","created","updated","actual_md5","actual_sha1" )

// -- or --
items.find ({
  "repo" : "repo-name",
  "path" : { "$match": "path/to/folder*" } ,
  "name" : { "$match": "name-*.json" }
}).include( "name","repo","path","created","actual_md5","actual_sha1","size","type","property" )

// -- or --
tems.find ({
  "path" : { "$ne" : "." },
  "repo" : "repo-name",
  "$or" : [
    {
      "$and" : [{
        "path" : { "$match": "path/to/folder" } ,
        "name" : { "$match": "name.zip" }
      }]
    },
    {
      "$and" : [{
        "path" : { "$match" : "path/to/folder/*" } ,
        "name" : { "$match" : "name.zip" }
      }]
    }
  ]
}).include( "name","repo","path","actual_md5","actual_sha1","size","type","property" )

$ curl -s -u "${account}":"${password}" \
          -XPOST \
          "${RT_URL}/artifactory/api/search/aql" \
          -T find.aql

in different repo

tems.find ({
  "path" : { "$ne" : "." },
  "$or" : [
    {
      "$and" : [{
        "repo" : "repo-name-1",
        "path" : { "$match": "path/to/folder/*" } ,
        "name" : { "$match": "name.txt" }
      }]
    },
    {
      "$and" : [{
        "repo" : "repo-name-2",
        "path" : { "$match" : "path/to/folder/*" } ,
        "name" : { "$match" : "name.txt"}
      }]
    }
  ]
}).include( "name", "repo", "path", "actual_md5", "actual_sha1", "size", "type", "property" )

find items (folder) some times ago by aql

• find root folder && 4 weeks ago (by using -T, --upload-file)

  [!NOTE|label:references:]

  • imarslo: write a file without indent space
  • find.aql: ```aql items.find ({ "repo": "my-repo", "type" : "folder" , "depth" : "1", "created" : { "$before" : "4w" } })

  $ curl [-fsSL] \
         -X POST \
         -uadmin:password https://artifactory.sample.com/artifactory/api/search/aql \
         -T find.aql
  

• search by using -d, --data

  $ curl -s \
         --netrc-file ~/.marslo/.netrc \
         -X POST https://artifactory.sample.com/artifactory/api/search/aql \
         -H "Content-Type: text/plain" \
         -d """items.find ({ \"repo\": \"my-repo\", \"type\" : \"folder\" , \"depth\" : \"1\", \"created\" : { \"\$before\" : \"4mo\" } }) """
  
  # -- or --
  $ curl -s \
         --netrc-file ~/.marslo/.netrc \
         -X POST https://artifactory.sample.com/artifactory/api/search/aql \
         -H "Content-Type: text/plain" \
         -d """items.find ({ \
                 \"repo\": \"my-repo\", \
                 \"type\" : \"folder\" , \
                 \"depth\" : \"1\", \
                 \"created\" : { \"\$before\" : \"4mo\" } \
              })
            """ \
         | jq --raw-output .results[].name?
  
  $ cat ~/.marslo/.netrc
  machine artifactory.sample.com
  login admin
  password password
  

  • or (with sort and limit)

    [!NOT|label:references] Artifactory query language (AQL). How to write a not match query with $nmatch

    $ curl -k -i \
           -H 'Content-Type:text/plain' \
           -X POST 'https://artifactory.sample.com/artifactory/api/search/aql' \
           -d 'items.find ({
                            "repo": "proj-1-local",
                            "type" : "folder" ,
                            "depth" : "1",
                            "created" : { "$before" : "3days" }
                          }).sort({"$desc":["created"]}).limit(1)
              '
    

  • or -d @<filename>

    [!NOTE|label:references:]

    • JFrog Artifactory REST API in 5min
    • build.aql:

      builds.find({
      "name" : "ci - build - name",
      "created" : { "$before" : "10d" }
      })
      

    $ curl -s -g \
           -d @builds.json \
           -H "Content-Type: text/plain" \
           -X POST "${RT_URL}/api/search/aql"
    

sort and limit

[!TIP|label:references:]

• Sorting in AQL
  • syntax:

    .sort({"<$asc | $desc>" : ["<field1>", "<field2>",... ]})
    

• Display Limits and Pagination
• ARTIFACTORY: AQL- How to sort by Properties

find most recent item

[!NOTE|label:references:]

• search in same repo

// sort by created timestamp
items.find(
  {"repo" : "repo-name"},
  {"path" : {"$match":"path/to/folder*"}},
  {"name" : {"$match":"name-*.json"}}
).include( "repo","path","name","created","updated","actual_md5","actual_sha1" )
 .sort({"$desc":["created"]})
 .limit(1)

find and pagination (sort and limit)

// run the same example, but this time, display up to 50 items but skipping the first 100
items.find({"name" : {"$match":"*.jar"})
     .sort({"$asc" : ["repo","name"]})
     .offset(100)
     .limit(50)

specify output fields

[!TIP|label:references:]

• Specify Output Fields

• Filtering Properties by Key

  // get all properties
  items.find().include("name", "repo", "property.*")
  
  // get `version` only
  items.find().include("name", "repo", "@version")
  

example

// Find all items, and display the "name" and "repo" fields as well as the number of "downloads" from the corresponding "stat" entity
items.find().include("name", "repo", "stat.downloads")

// Find all items, and display the default item fields fields as well as the stat fields
items.find().include("stat")

// Find all items, and display the default item fields as well as the stat and the property fields
items.find().include("stat", "property")

// Find all items, and display the "name" and "repo" fields as well as the stat fields
items.find().include("name", "repo", "stat")

// Find all builds that generated items with an Apache license, and display the build fields as well as the item "name" fields. Click below to view the output of this query
builds.find(
  {
    "module.artifact.item.@license":{"$match":"Apache*"}
  }
).include("module.artifact.item.name")

call aql via CURL

running via curl -d

running via curl -T