CloudKitのデータをCSVにExportする方法(Swift5)

iOS アプリを開発するときに、データの格納先としてCloudKit を選択することは多いのではないだろうか。CloudKit はiCloud 上のデータベースで、アプリ単位1PB まで利用できる。 

CloudKit Dashboard という管理機能も備え、スキーマやレコードの管理もでき非常に便利なのだが、一つ大きな欠点がある。


CloudKit Dashboard からデータをエクスポートできない

報告や分析するときにデータをエクスポートして加工することは多いのではないだろうか。残念ながらCloudKit Dashboard 上では、そこまでグラフィカルな表現はできず、またデータのエクスポート機能も備えていない。

そこで今回はSwift5 でCloudKit のデータをCSV にExport する方法を書く。


Swift5 でCloudKit のデータをCSV にExport する

ソースコード

    private func exportCloudKit(){
            let df = DateFormatter()
            df.dateFormat = "yyyy-MM-dd HH:mm:ss"
            // Change header
            var text = "Created,Code,Name\n";

            cloudKitLoadRecords() { (records, error) -> Void in
                if let error = error {
                    print(error)
                } else {
                    if let records = records {
                        for record in records{
                            // Change Fields
                            let date = record.creationDate != nil ? df.string(from: record.creationDate!) : ""
                            let code = record["code"] as! String
                            let name = record["name"] != nil ? record["name"] as! String : ""
                            text += date + "," + code + "," + name + "," + "\n"
                        }
                    }
                    
                    let dir = FileManager.default.urls(
                        for: .documentDirectory,
                        in: .userDomainMask
                    ).first!
                    let fileUrl = dir.appendingPathComponent("CloudKitExport.csv")

                    if FileManager.default.createFile(
                                    atPath: fileUrl.path,
                                    contents: text.data(using: .utf8),
                                    attributes: nil
                                    ) {
                    } else {
                        print("Failed to create file")
                    }
                    
                    print("Processed")
                }
            }
        }

    func cloudKitLoadRecords(result: @escaping (_ objects: [CKRecord]?, _ error: Error?) -> Void) {
        // Change recordType
        let cloudKitQuery = CKQuery(recordType: "Sample", predicate: NSPredicate(value: true))

        var records = [CKRecord]()

        // If you use Private Database, Chage here 'CKContainer.default().privateCloudDatabase'
        let database = CKContainer.default().publicCloudDatabase

        var recurrentOperationsCounter = 101
        func recurrentOperations(cursor: CKQueryOperation.Cursor?){
            let recurrentOperation = CKQueryOperation(cursor: cursor!)
            recurrentOperation.recordFetchedBlock = { (record:CKRecord!) -> Void in
                recurrentOperationsCounter += 1
                records.append(record)
            }
            recurrentOperation.queryCompletionBlock = { (cursor: CKQueryOperation.Cursor?, error: Error?) -> Void in
                if ((error) != nil) {
                    print(String(describing: error))
                    result(nil, error)
                } else {
                    if cursor != nil {
                        recurrentOperations(cursor: cursor!)
                    } else {
                        result(records, nil)
                    }
                }
            }
            database.add(recurrentOperation)
        }

        var initialOperationCounter = 1
        let initialOperation = CKQueryOperation(query: cloudKitQuery)
        initialOperation.recordFetchedBlock = { (record:CKRecord!) -> Void in
            initialOperationCounter += 1
            records.append(record)
        }
        initialOperation.queryCompletionBlock = { (cursor: CKQueryOperation.Cursor?, error: Error?) -> Void in
            if ((error) != nil) {
                print(String(describing: error))
                result(nil, error)
            } else {
                if cursor != nil {
                    recurrentOperations(cursor: cursor!)
                } else {
                    result(records, nil)
                }
            }
        }
        database.add(initialOperation)
    }

使い方

今回の例では手間を省くためXCode のApp デフォルトで作成されるものをベースに、ContentView.swift に↑のfunc を置いてbody を以下のように変更した。 

    var body: some View {
        List {
        }
        .toolbar {
            Button(action: exportCloudKit) {
                Label("export", systemImage: "square.and.arrow.down")
            }
        }
    }

CloudKitExporter 画面

右上のボタンを押すとCSV を出力する。

CSV の出力先は、ユーザ名\ライブラリ\Containers\ツール名\Data\Documents になるので、場所がわからないときはファイル名(CloudKitExport.csv)で検索する。


使うときに変更する箇所

CSV のヘッダ。今回はCreated, Code, Name の3つを出力している 

// Change header
var text = "Created,Code,Name\n";

出力したいフィールド。値がない可能性があるフィールドは、name のようにnilチェックする 

// Change Fields
let date = record.creationDate != nil ? df.string(from: record.creationDate!) : ""
let code = record["code"] as! String
let name = record["name"] != nil ? record["name"] as! String : ""
text += date + "," + code + "," + name + "," + "\n"

出力したいRecordType。

// Change recordType
let cloudKitQuery = CKQuery(recordType: "Sample", predicate: NSPredicate(value: true))

データベースがPublic かPrivate か

// If you use Private Database, Chage here 'CKContainer.default().privateCloudDatabase'
let database = CKContainer.default().publicCloudDatabase

設定方法は後述するが、Production かDevelopment か

entitlements 画面


ハマったポイント

100レコードまでしか出力されない

最初はperformQuery を使っていたが、100レコードまでしか出力されなかった。CKQueryOperation を使って回す必要があった。


デバッグ実行でProduction からデータを出力したい

特に設定しない場合は、Development からデータが出力された。以下の設定をすることでProduction から出力できた。

  • entitlements を開く
  • +ボタンを押して、com.apple.developer.icloud-container-environment のキーを追加する
  • Type をString 、Value をProduction に設定する。

entitlements 画面

コメント

コメントを投稿

このブログの人気の投稿

メールのURL(リンク)が途切れる問題に対応するアドイン(Outlook)

イメージ
Outlook(デスクトップ版) では、いろいろな条件で本文に書いたURLのリンクが途切れる。例えば以下ようなURLだ。 長いURL マルチバイトの文字が入ったURL 空白が入ったURL メールがHTML形式であれば、ハイパーリンクにすればいいが、テキスト形式の場合はハイパーリンクが使えない。テキスト形式でも<>をつければ途切れないようになるが、毎回手動でつけるのは煩雑だ。 Outlook でリンクが途切れないように<>を自動でつけるアドイン そこでOutlook アドインを作成した。以下からダウンロードできる。 https://f.easyuploader.app/20210805063548_4b33376c.zip こういったメールを送信時に このように<>を自動でつけてくれる。\\ とhtml から始まる行が対象になる。 インストール方法 Complementor.zip をダウンロードして解凍する。 setup.exe を実行する。 SmartScreen のメッセージが表示された場合は、詳細情報→実行をクリックする。 インストールをクリックする。 インストール時にOutlook が起動していた場合は、アドインを読み込むため一度Outlook を再起動すると有効になる。一度有効になった後は、特に設定なく自動で<>を付与する。 ちなみに不要になった場合は、Windowsの「アプリと機能」からアンインストールできる。「Complementor」の名称で登録されている。
続きを読む

メールからRedmineのチケットを作成するアドイン(Outlook)

イメージ
メールからタスクが発生することはまだ多い。その時メールの本文をコピーして、Redmineを開いて、チケット作成画面を開いて、説明欄に貼り付けてチケットを作成すると思うが、煩雑ではないだろうか。 Outlook からRedmine のチケットを作成するアドイン そこでOutlook アドインを作成した。以下からダウンロードできる。 https://f.easyuploader.app/20210804205153_6456326c.zip このアドインはOutlook(デスクトップ版)に、「Redmineに送る」右クリックメニューを追加する。 「Redmineに送る」右クリックメニューをクリックすると、メールの件名と本文を転記した状態でチケット作成フォームが開く。 チケット作成フォームを確定することで、Redmine にチケットを作成する。 インストール方法 SendToRedmine.zip をダウンロードして解凍する。 setup.exe を実行する。 SmartScreen のメッセージが表示された場合は、詳細情報→実行をクリックする。 インストールをクリックする。 インストール時にOutlook が起動していた場合は、アドインを読み込むため一度Outlook を再起動すると有効になる。 初期設定 Outlook 上部の「アドイン」 → 「設定」をクリックする。 RedmineUrl とApiKey を入力して、Project選択ボタンを押して確定すれば使用できるようになる。 各項目は以下の通り。 ・設定名：任意の文字列(※Project選択ボタンでプロジェクト選択すると上書きされる) ・RedmineUrl：Redmine のURL (http://example.com/redmine/ のよ
続きを読む

複数行テキストの「表示数を増やす」を自動で開くChrome拡張機能(SharePointモダンリスト)

イメージ
SharePoint モダンリストの複数行テキストは、以下のように縮小された状態で表示される。 すべての文章を見るには「表示数を増やす」をクリックする必要がある。それなりの行数が予め表示されるのであればよいが、2、3行しか表示されない。そのため、ほぼ全てのアイテムが見切れた状態で表示される。 つまりリストの内容を見たければ、アイテムと「表示数を増やす」の2度のクリックが"毎回"必要ということだ。これは非常に面倒だ。 そこで、アイテムを「表示数を増やす」をクリックした状態で開くChrome 拡張機能を作成してChrome ウェブストアに公開した。 Chrome ウェブストア ちなみに、他にも回避方法はあるようだ。Microsoft のCommunity に 同様の問い合わせ があった。 1. Access to the list. 2. Click PowerApps>select Customize forms>select the text input. 3. Click Properties>change the Size: とのことだが、PowerApps が許可されていなかったり、SharePoint の設定変更する権限がない場合、手の打ちようがない。 そのため各自で対応できるChrome 拡張機能を作ったというのが経緯だ。ChromeとChromium ブラウザであれば拡張機能を利用できるので、汎用性も高い。 ソースコード manifest.json { "name": "SharePoint Modern List See More", "description": "When displaying the item in the Modern List, display it in the state that clicked 'See More'.",
続きを読む

Google Meetの参加リクエストを自動承諾するChrome拡張機能

イメージ
現在、様々なオンライン会議システムがあるが、普段何をお使いだろうか。私はGoogle Meetを多用している。 通信が安定していることはもちろん、100人まで参加できチャットや画面共有機能も備える。PC、スマホを問わず、アプリのインストール不要でブラウザのみで動作する。 これがGoogle アカウントさえあれば無料で利用でき、最大24時間途切れることなく会話が可能だ。(※2021/6/28以降は無料プランの場合1時間までとなる。 Google Meet プランと料金 ) そんな素晴らしいGoogle Meet だが、一つだけ面倒な点がある。 参加リクエストを毎回手動で承諾する必要がある。 この画面だ。 会議作成時に出席者を登録しておけば承諾なしに入れるようだが、私の場合さっと会議URLだけ作って相手にメールで送るので、新たな参加があるたびに承諾ボタンをクリックする必要がある。これが面倒だった。 既存のChrome 拡張機能で自動承認すると書かれたものがいくつかあったが、日本語に対応していなかったのと、何やら別の処理が含まれていたので自分で作ることにした。 自動で承諾するChrome 拡張機能を作成した。 chrome ウェブストア へのリンクは以下。 Google Meet の「この通話への参加をリクエストしているユーザーがいます」を自動で承諾する。 ちなみにソースコードには以下の処理しか書いていないので安心してほしい。 function autoAdmit() { document.querySelectorAll('[class="RveJvd snByac"]').forEach((element, index) => { // 0:Deny entry, 1:Admit if (index == 1){ element.click(); } }) } setInterval(autoAdmit, 2000); これで毎回クリックする手間から開放された。もちろんChrome 以外のchromium ブ
続きを読む

もしもアフィリエイト かんたんリンク文字化け対策ツール(全角→半角記号変換)

イメージ
もしもアフィリエイト かんたんリンクの商品名、メーカー(出版社)に含まれる全角記号を半角記号に変換して文字化けを防ぐ。 「HTMLソース(メディア掲載用)」を全文コピーして、上のテキストボックスに貼り付ける。変換ボタンを押すと下のテキストボックスに変換したものを表示する。 変換 クリップボードにコピー 作成した経緯 もしもアフィリエイトのかんたんリンクで、以下のような全角空白や全角記号を含むリンクを作成する。 「HTMLソース(メディア掲載用)」を全文コピーしてBlogger のHTML に貼り付けると、このように表示される。 正確には文字化けではなく文字実体参照というようだが、全角空白が「&#12288;」になったり、・(中点)が「&#12539;」になったりする。 多少であれば手動でHTML を直してもいいが、上記のように大量にあると1つ1つ直すのも面倒だ。そこでjavascript を使って全角記号から半角記号に変換することで、文字実体参照されないように対策する。 仕様 変換対象 商品名"n" とメーカー(出版社)"b" が変換する対象となる。 変換仕様 仕様1 以下のUnicode 表に従い、「！」から「～」までを半角英数記号に変換する。 仕様2 Unicode 表にない以下の記号を個別に変換する。 ” → \" ’ → ' ‘ → ` ￥ → \\ 　(全角空白) →  (半角空白) 〜 → ~ ・ →  (中点は半角記号に該当がないため半角空白に変換) 【 → [ 】 → ] 上手く動作しない場合や、変換する記号の追加リクエストはコメントまで。
続きを読む